Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
generated-src
LICENSE
NOTICE
Podfile
README.md

README.md

This ObjC package is automatically generated by the Swagger Codegen project:

  • API version:
  • Package version:
  • Build date:
  • Build package:

Requirements

The SDK requires ARC (Automatic Reference Counting) to be enabled in the Xcode project.

Installation & Usage

Install from Github using CocoaPods

Add the following to the Podfile:

pod '', :git => 'https://github.com//.git'

To specify a particular branch, append , :branch => 'branch-name-here'

To specify a particular commit, append , :commit => '11aa22'

Install from local path using CocoaPods

Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/) and then add the following to the Podfile:

pod '', :path => 'Vendor/'

Usage

Import the following:

#import </ApiClient.h>
#import </Configuration.h>
// load models
#import </NECIDCandidate.h>
#import </NECIDAttributes.h>
#import </NECIDAttributes_rightEyeCenter.h>
#import </NECIDSearchResult.h>
#import </NECIDExtractResult.h>
#import </NECIDSubject.h>
#import </NECIDJobSummary.h>
#import </NECIDJobStatus.h>
#import </NECIDAttributes_headArea.h>
#import </NECIDAttributes_faceArea.h>
#import </NECIDEvents.h>
#import </NECIDAttributes_leftEyeCenter.h>
#import </NECIDEvent.h>
#import </NECIDSubjectList.h>
#import </NECIDTag.h>
#import </NECIDJob.h>
// load API classes for accessing endpoints
#import </NECIDBiometricAPIClient.h>

Recommendation

It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issue.

Getting Started

Please follow the installation procedure and then run the following:


NECIDBiometricAPIClient *apiInstance = [[NECIDBiometricAPIClient alloc] init];

[apiInstance faceExtractPostWithCompletionHandler: 
              ^(NECIDExtractResult * output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Documentation for API Endpoints

All URIs are relative to https://api.id.nec.com.au/v1.1

Class Method HTTP request Description
NECIDBiometricAPIClient faceExtractPost POST /face/extract
NECIDBiometricAPIClient faceExtractOptions OPTIONS /face/extract
NECIDBiometricAPIClient faceSearchPost POST /face/search
NECIDBiometricAPIClient faceSearchOptions OPTIONS /face/search
NECIDBiometricAPIClient faceVerifyPost POST /face/verify
NECIDBiometricAPIClient faceVerifyOptions OPTIONS /face/verify
NECIDBiometricAPIClient healthGet GET /health
NECIDBiometricAPIClient healthOptions OPTIONS /health
NECIDBiometricAPIClient jobsBulkregisterPost POST /jobs/bulkregister
NECIDBiometricAPIClient jobsBulkregisterOptions OPTIONS /jobs/bulkregister
NECIDBiometricAPIClient jobsBulkregisterBatchIdGet GET /jobs/bulkregister/{batchId}
NECIDBiometricAPIClient jobsBulkregisterBatchIdOptions OPTIONS /jobs/bulkregister/{batchId}
NECIDBiometricAPIClient jobsBulkregisterBatchIdPagingIdGet GET /jobs/bulkregister/{batchId}/{pagingId}
NECIDBiometricAPIClient jobsBulkregisterBatchIdPagingIdOptions OPTIONS /jobs/bulkregister/{batchId}/{pagingId}
NECIDBiometricAPIClient subjectsGet GET /subjects
NECIDBiometricAPIClient subjectsPost POST /subjects
NECIDBiometricAPIClient subjectsOptions OPTIONS /subjects
NECIDBiometricAPIClient subjectsSubjectIdPut PUT /subjects/{subjectId}
NECIDBiometricAPIClient subjectsSubjectIdDelete DELETE /subjects/{subjectId}
NECIDBiometricAPIClient subjectsSubjectIdOptions OPTIONS /subjects/{subjectId}
NECIDBiometricAPIClient subjectsSubjectIdEventsGet GET /subjects/{subjectId}/events
NECIDBiometricAPIClient subjectsSubjectIdEventsPost POST /subjects/{subjectId}/events
NECIDBiometricAPIClient subjectsSubjectIdEventsOptions OPTIONS /subjects/{subjectId}/events
NECIDBiometricAPIClient subjectsSubjectIdEventsEventIdPut PUT /subjects/{subjectId}/events/{eventId}
NECIDBiometricAPIClient subjectsSubjectIdEventsEventIdDelete DELETE /subjects/{subjectId}/events/{eventId}
NECIDBiometricAPIClient subjectsSubjectIdEventsEventIdOptions OPTIONS /subjects/{subjectId}/events/{eventId}
NECIDBiometricAPIClient tagsGet GET /tags
NECIDBiometricAPIClient tagsOptions OPTIONS /tags
NECIDBiometricAPIClient tagsNamePut PUT /tags/{name}
NECIDBiometricAPIClient tagsNamePost POST /tags/{name}
NECIDBiometricAPIClient tagsNameDelete DELETE /tags/{name}
NECIDBiometricAPIClient tagsNameOptions OPTIONS /tags/{name}

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

You can’t perform that action at this time.