### Enabling ID-Card Test Guide Source: https://docs.nhncloud.com/ko/nhncloud/ko/nhncloud-sdk/idcard-recognizer-ios Example of how to initialize the OCR service and enable the test guide. This allows you to use a predefined ID-card guide for testing OCR functionality. ```objective-c - (void)initializeOCR { // 초기화 및 Delegate 설정 NHNCloudOCRConfiguration *configuration = [NHNCloudOCRConfiguration configurationWithAppKey:@"{AppKey}" secret:@"{Secret}" ]; [configuration enableTestGuide]; [NHNCloudOCR initWithConfiguration:configuration]; [NHNCloudOCR setIDCardRecognizerDelegate:self]; } ``` -------------------------------- ### Exported File Fields Example Source: https://docs.nhncloud.com/ko/Application%20Service/File%20Crafter/ko/api-guide Example of how to map response keys to header names for the exported file. ```json { "name": "이름", "number": "연락처" } ``` -------------------------------- ### Exported File Sheets Example Source: https://docs.nhncloud.com/ko/Application%20Service/File%20Crafter/ko/api-guide Example configuration for exporting data into multiple sheets with specific queries. ```json [ { "sheetQuery": "October", "sheetName": "10월" } ] ``` -------------------------------- ### Example PEM Certificate Structure Source: https://docs.nhncloud.com/ko/Application%20Service/ShortURL/ko/console-guide This is an example of the expected structure for a .pem certificate file, including the certificate and private key. ```pem -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- -----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY----- ``` -------------------------------- ### Create Model - Response Example Source: https://docs.nhncloud.com/ko/Application%20Service/API%20Gateway/ko/api-guide-v1.0 This is an example of a successful response after creating a model. It returns the details of the newly created model, including its ID, name, schema, and timestamps. ```json { "header": { "isSuccessful": true, "resultCode": 0, "resultMessage": "SUCCESS" }, "model": { "modelId": "{modelId}", "apigwServiceId": "{apigwServiceId}", "modelName": "UserModel", "modelDescription": "This is a user model.", "modelSchema": { "type": "object", "properties": { "userName": { "type": "string" }, "userDescription": { "description": "user description", "type": "string", "maxLength": 128 } }, "required": [ "userName" ] }, "createdAt": "2021-10-11T23:51:47.000Z", "updatedAt": "2021-10-11T23:51:47.000Z" } } ``` -------------------------------- ### Export Callback Request Example Source: https://docs.nhncloud.com/ko/Application%20Service/File%20Crafter/ko/api-guide Example of a callback request URL including a sheet query parameter. ```http http://my.service.com/api/export?sheetQuery=October ``` -------------------------------- ### Exported File Structure Example Source: https://docs.nhncloud.com/ko/Application%20Service/File%20Crafter/ko/api-guide Illustrates the resulting file structure based on the 'exportedFile.fields' mapping. ```text 이름 | 연락처 ---|--- Jason | 01012341234 Tim | 01043214321 ``` -------------------------------- ### User Group Details Response Example Source: https://docs.nhncloud.com/ko/Database/RDS%20for%20MySQL/ko/api-guide-v4.0 Example response for retrieving a specific user group's details, including its type and associated members. ```json { "header": { "resultCode": 0, "resultMessage": "SUCCESS", "isSuccessful": true }, "userGroupId": "1aac0437-f32d-4923-ad3c-ac61c1cfdfe0", "userGroupName": "dev-team", "userGroupTypeCode": "INDIVIDUAL_MEMBER", "members": [ { "memberId": "1321e759-2ef3-4b85-9921-b13e918b24b5" } ], "createdYmdt": "2023-02-23T10:07:54+09:00", "updatedYmdt": "2023-02-26T01:15:50+09:00" } ``` -------------------------------- ### Export Callback Response Example Source: https://docs.nhncloud.com/ko/Application%20Service/File%20Crafter/ko/api-guide Sample data structure received from the export callback. ```json [ {"name": "Jason", "number": "01012341234"}, {"name":"Tim", "number": "01043214321"} ] ``` -------------------------------- ### User Group List Response Example Source: https://docs.nhncloud.com/ko/Database/RDS%20for%20MySQL/ko/api-guide-v4.0 Example response structure for listing user groups, including group ID, name, and timestamps. ```json { "header": { "resultCode": 0, "resultMessage": "SUCCESS", "isSuccessful": true }, "userGroups": [ { "userGroupId": "1aac0437-f32d-4923-ad3c-ac61c1cfdfe0", "userGroupName": "dev-team", "createdYmdt": "2023-02-23T10:07:54+09:00", "updatedYmdt": "2023-02-26T01:15:50+09:00" } ] } ``` -------------------------------- ### List Models - Response Example Source: https://docs.nhncloud.com/ko/Application%20Service/API%20Gateway/ko/api-guide-v1.0 This is an example of a successful response when listing models. It includes pagination details and a list of model objects, each with its ID, name, description, schema, and timestamps. ```json { "header": { "isSuccessful": true, "resultCode": 0, "resultMessage": "SUCCESS" }, "paging": { "limit": 10, "page": 1, "totalCount": 1 }, "modelList": [ { "modelId": "{modelId}", "apigwServiceId": "{apigwServiceId}", "modelName": "UserModel", "modelDescription": "This is a user model.", "modelSchema": { "type": "object", "properties": { "userName": { "type": "string" }, "userDescription": { "description": "user description", "type": "string", "maxLength": 128 } }, "required": [ "userName" ] }, "createdAt": "2021-10-11T23:51:47.000Z", "updatedAt": "2021-10-11T23:51:47.000Z" } ] } ``` -------------------------------- ### Create Model - Request Body Example Source: https://docs.nhncloud.com/ko/Application%20Service/API%20Gateway/ko/api-guide-v1.0 This is an example of a request body for creating a new model. It specifies the model's name, description, and its JSON Schema definition. ```json { "modelName": "UserModel", "modelDescription": "This is a user model.", "modelSchema": { "type": "object", "properties": { "userName": { "type": "string" }, "userDescription": { "description": "user description", "type": "string", "maxLength": 128 } }, "required": [ "userName" ] } } ``` -------------------------------- ### Enabling Test Guide for ID Card Recognition Source: https://docs.nhncloud.com/ko/nhncloud/ko/nhncloud-sdk/idcard-recognizer-ios This section explains how to use the test guide provided by the NHNCloudOCR SDK to test ID card recognition functionality. The test guide helps in verifying OCR by ensuring the ID card is within the guide area. ```APIDOC ## ID-Card 가이드 API 명세 @interface NHNCloudOCRConfiguration : NSObject - (void)enableTestGuide; @end ``` ```APIDOC ## ID-Card 가이드 사용 예 - (void)initializeOCR { // 초기화 및 Delegate 설정 NHNCloudOCRConfiguration *configuration = [NHNCloudOCRConfiguration configurationWithAppKey:@"{AppKey}" secret:@"{Secret}" ]; [configuration enableTestGuide]; [NHNCloudOCR initWithConfiguration:configuration]; [NHNCloudOCR setIDCardRecognizerDelegate:self]; } ``` -------------------------------- ### Example Request for Sending AlimTalk Message Source: https://docs.nhncloud.com/ko/Notification/KakaoTalk%20Bizmessage/ko/alimtalk-api-guide This cURL example demonstrates how to send an AlimTalk message with a specified sender key, template code, request date, recipient number, and template parameters. Replace placeholders with your actual values. ```curl curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" https://kakaotalk-bizmessage.api.nhncloudservice.com/alimtalk/v2.3/appkeys/{appkey}/messages -d '{"senderKey":"{발신 키}","templateCode":"{템플릿 코드}","requestDate":"2018-10-01 00:00","recipientList":[{"recipientNo":"{수신번호}","templateParameter":{"{치환자 필드}":"{치환 데이터}"}}]}' ``` -------------------------------- ### Epic Games Additional Info Settings Example Source: https://docs.nhncloud.com/ko/Game/Gamebase/ko/oper-app Configure additional information for Epic Games authentication, including deployment ID and scope, in JSON string format. ```json { "deployment_id": "Your Deployment ID", "scope": ["basic_profile", "friends_list", "presence"] } ``` -------------------------------- ### Certificate Authentication Details Response Source: https://docs.nhncloud.com/ko/Security/Secure%20Key%20Manager/ko/api-guide-v1.3 Example response body for retrieving certificate authentication details, including name, password, description, expiration date, and access/creation/change timestamps. ```JSON { "header": { ... }, "body": { "certificateList": [ { "name": "certificate1", "password": "password1", "description": "인증서 설명", "expirationDate": "2029-07-21T10:26:47", "lastAccessDatetime": "2025-01-25T13:00:00", "deletionDatetime": null, "creationUser": "SECURE_KEY_MANAGER", "creationDatetime": "2025-01-25T12:00:00", "lastChangeUser": "SECURE_KEY_MANAGER", "lastChangeDatetime": "2025-01-30T15:00:00.000" } ] } } ``` -------------------------------- ### Get Certificate Authentication Details Source: https://docs.nhncloud.com/ko/Security/Secure%20Key%20Manager/ko/api-guide-v1.3 Retrieves detailed information about certificate authentication settings within a Secure Key Manager keystore. Requires the application key, keystore ID, and the certificate name. ```HTTP GET https://api-keymanager.nhncloudservice.com/keymanager/v1.3/appkey/{appkey}/keystores/{keyStoreId}/certificates?value={certificateName} ``` -------------------------------- ### Send IAM Account Password Setup Email Source: https://docs.nhncloud.com/ko/nhncloud/ko/public-api/framework-api API to send an email for changing the IAM account password. Requires Organization.Member.Iam.Update permission. ```APIDOC ## POST /v1/iam/organizations/{org-id}/members/{member-id}/send-password-setup-mail ### Description API to send an email that allows changing the IAM account password. ### Method POST ### Endpoint /v1/iam/organizations/{org-id}/members/{member-id}/send-password-setup-mail ### Parameters #### Path Parameters - **org-id** (String) - Required - Organization ID of the target - **member-id** (String) - Required - UUID of the IAM account whose password needs to be changed #### Request Body - **request** (SendPasswordSetupMailRequest) - Required - Request details ### SendPasswordSetupMailRequest - **locale** (String) - Required - User's locale information (e.g., ko) - **returnUrl** (String) - Required - URL to redirect to after password change via email. Must be a domain of toast.com, dooray.com, or nhncloud.com. ### Response #### Success Response (200) - **header** (Common Response) - Yes ### Response Example ```json { "header": { "isSuccessful": true, "resultCode": 0, "resultMessage": "resultMessage" } } ``` ``` -------------------------------- ### Customizing NHNCloudIDCardRecognizerServiceViewController Source: https://docs.nhncloud.com/ko/nhncloud/ko/nhncloud-sdk/idcard-recognizer-ios Example of subclassing NHNCloudIDCardRecognizerServiceViewController to implement custom UI and handle ID card detection events. Ensure to set the delegate and call super methods. ```objective-c @interface OCRViewController : NHNCloudIDCardRecognizerServiceViewController @end @implementation OCRViewController - (void)viewDidLoad { [super viewDidLoad]; [NHNCloudOCR setIDCardRecognizerDelegate:self]; // Custom UI 생성 } - (void)viewWillAppear:(BOOL)animated { [super viewWillAppear:animated]; [self startRunning]; } - (void)viewWillDisappear:(BOOL)animated { [super viewWillDisappear:animated]; } - (void)viewDidDisappear:(BOOL)animated { [super viewDidDisappear:animated]; } - (void)didUpdateIDCardGuide:(CGRect)rect { [super didUpdateIDCardGuide:rect]; // Custom UI 갱신 } - (void)imageDidDetect:(BOOL)detected { [super imageDidDetect:detected]; // 신분증 인식 시 UI 갱신 } - (void)didDetectIDCardInfo:(nullable NHNCloudIDCardInfo *)cardInfo error:(nullable NSError *)error { NSLog(@"didDetectIDCardInfo : cardInfo : %@", cardInfo); NSLog(@"didDetectIDCardInfo : error : %@", error); } ``` -------------------------------- ### Get User ID and Group ID Source: https://docs.nhncloud.com/ko/Storage/Storage%20Gateway/ko/console-guide Use the `id` command in a Linux shell to find the user ID (uid) and group ID (gid) of the current user. This is useful for configuring NFS permissions. ```bash $ id uid=1000(ubuntu) gid=1000(ubuntu) groups=1000(ubuntu) ``` -------------------------------- ### Combine Certificate Files Source: https://docs.nhncloud.com/ko/Application%20Service/ShortURL/ko/console-guide Concatenate your domain certificate, private key, and root CA chain into a single .pem file. ```bash cat mydomain.crt mydomain.key root-ca-chain.pem > mydomain.pem ``` -------------------------------- ### Maven Repository 설정 Source: https://docs.nhncloud.com/ko/Application%20Service/ROLE/ko/sdk-guide JAVA Client SDK를 사용하기 위해 필요한 Maven Repository를 pom.xml에 추가합니다. ```xml com.toast.cloud TOAST Cloud Repository http://nexus.nhnent.com/content/repositories/releases ``` -------------------------------- ### Example API Response Body Source: https://docs.nhncloud.com/ko/Application%20Service/ROLE/ko/error-code This is an example of the response body structure from the Application Service ROLE API. When an API call is successful, 'isSuccessful' is true and 'resultCode' is 0. If it fails, 'isSuccessful' is false and 'resultCode' indicates the specific error. ```json { "header" : { "isSuccessful" : true, "resultCode": 0, "resultMessage" : "SUCCESS" } } ``` -------------------------------- ### Import 콜백: 응답 본문 형식 Source: https://docs.nhncloud.com/ko/Application%20Service/File%20Crafter/ko/callback-api-guide Import 콜백 API의 응답 본문은 'header'와 'errors' 필드를 포함합니다. 'header'는 처리 결과를, 'errors'는 실패한 항목 목록을 나타냅니다. ```json { "header": { "resultCode": 0, "resultMessage": "success", "isSuccessful": true }, "errors": [] } ``` -------------------------------- ### Speech Recognition API Response Example Source: https://docs.nhncloud.com/ko/AI%20Service/Speech%20to%20Text/ko/api-guide This is an example of a successful response from the Speech to Text API. It includes a header indicating success and a result object containing the transcribed text, input length, file type, and confidence score. ```json { "header": { "isSuccessful": true, "resultCode": 0, "resultMessage": "SUCCESS" }, "result": { "inputLength": 1.85, "fileType": "mp3", "text": "안녕하세요.", "confidence": 0.94 } } ``` -------------------------------- ### API Success Response Example Source: https://docs.nhncloud.com/ko/Database/RDS%20for%20MySQL/ko/api-guide-v4.0 Standard success response structure for API operations like create, modify, and delete. ```json { "header": { "resultCode": 0, "resultMessage": "SUCCESS", "isSuccessful": true } } ``` -------------------------------- ### Get Session Count in Channel Source: https://docs.nhncloud.com/ko/Application%20Service/RTCS/ko/error-code Obtain the number of sessions connected to a channel. This feature supports 'presence' and 'member' channel types. ```http GET /v2/channel/{appkey}/count?channel={channel_name} ``` -------------------------------- ### Get Sessions in Channel Source: https://docs.nhncloud.com/ko/Application%20Service/RTCS/ko/error-code Retrieve a list of sessions currently joined to a channel. This functionality is available for 'presence' and 'member' channel types. ```http GET /v2/channel/{appkey}/sessions?channel={channel_name} ``` -------------------------------- ### Verify DNS A Record with nslookup Source: https://docs.nhncloud.com/ko/Application%20Service/ShortURL/ko/console-guide Use the nslookup command to verify that your domain's A record is correctly pointing to the provided IP address. ```bash Name: nh.nu Address: 180.210.71.141 ```