Chilkat Online Tools

Objective-C / Belvo API Docs / Update

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
#import <NSString.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.BasicAuth = YES;
http.Login = @"{{secretId}}";
http.Password = @"{{secretPassword}}";

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "password": "password",
//   "password2": "pin",
//   "token": "1234ab",
//   "encryption_key": "customencryptionkey",
//   "username_type": "001",
//   "certificate": "1234567890abcd=",
//   "private_key": "1234567890abcd="
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"password" value: @"password"];
[json UpdateString: @"password2" value: @"pin"];
[json UpdateString: @"token" value: @"1234ab"];
[json UpdateString: @"encryption_key" value: @"customencryptionkey"];
[json UpdateString: @"username_type" value: @"001"];
[json UpdateString: @"certificate" value: @"1234567890abcd="];
[json UpdateString: @"private_key" value: @"1234567890abcd="];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://domain.com/api/links/:id/" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "<uuid>",
//   "institution": "<string>",
//   "access_mode": "<string>",
//   "last_accessed_at": "<dateTime>",
//   "status": "<string>",
//   "created_by": "<uuid>",
//   "refresh_rate": "<string>"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *id = [jResp StringOf: @"id"];
NSString *institution = [jResp StringOf: @"institution"];
NSString *access_mode = [jResp StringOf: @"access_mode"];
NSString *last_accessed_at = [jResp StringOf: @"last_accessed_at"];
NSString *status = [jResp StringOf: @"status"];
NSString *created_by = [jResp StringOf: @"created_by"];
NSString *refresh_rate = [jResp StringOf: @"refresh_rate"];

Curl Command

curl -X PUT
	-u '{{secretId}}:{{secretPassword}}'
	-H "Content-Type: application/json"
	-d '{
    "password": "password",
    "password2": "pin",
    "token": "1234ab",
    "encryption_key": "customencryptionkey",
    "username_type": "001",
    "certificate": "1234567890abcd=",
    "private_key": "1234567890abcd="
}'
https://domain.com/api/links/:id/

Postman Collection Item JSON

{
  "name": "Update",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"password\": \"password\",\n    \"password2\": \"pin\",\n    \"token\": \"1234ab\",\n    \"encryption_key\": \"customencryptionkey\",\n    \"username_type\": \"001\",\n    \"certificate\": \"1234567890abcd=\",\n    \"private_key\": \"1234567890abcd=\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/links/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "links",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `link.id` you want to update."
        }
      ]
    },
    "description": "Update the credentials of a specific link.\n\n✅ We recommend using our [Connect Widget in Update Mode](https://developers.belvo.com/docs/connect-widget-update-mode) to handle updating `invalid` or `token_required` links.\n"
  },
  "response": [
    {
      "name": "Ok",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"password\": \"<string>\",\n    \"password2\": \"<string>\",\n    \"token\": \"<string>\",\n    \"encryption_key\": \"<string>\",\n    \"username_type\": \"<string>\",\n    \"certificate\": \"<string>\",\n    \"private_key\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/links/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"id\": \"<uuid>\",\n\t\"institution\": \"<string>\",\n\t\"access_mode\": \"<string>\",\n\t\"last_accessed_at\": \"<dateTime>\",\n\t\"status\": \"<string>\",\n\t\"created_by\": \"<uuid>\",\n\t\"refresh_rate\": \"<string>\"\n}"
    },
    {
      "name": "Bad request error",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"password\": \"<string>\",\n    \"password2\": \"<string>\",\n    \"token\": \"<string>\",\n    \"encryption_key\": \"<string>\",\n    \"username_type\": \"<string>\",\n    \"certificate\": \"<string>\",\n    \"private_key\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/links/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"password\": \"<string>\",\n    \"password2\": \"<string>\",\n    \"token\": \"<string>\",\n    \"encryption_key\": \"<string>\",\n    \"username_type\": \"<string>\",\n    \"certificate\": \"<string>\",\n    \"private_key\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/links/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    },
    {
      "name": "Too Many Sessions",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"password\": \"<string>\",\n    \"password2\": \"<string>\",\n    \"token\": \"<string>\",\n    \"encryption_key\": \"<string>\",\n    \"username_type\": \"<string>\",\n    \"certificate\": \"<string>\",\n    \"private_key\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/links/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    },
    {
      "name": "MFA Token Required",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"password\": \"<string>\",\n    \"password2\": \"<string>\",\n    \"token\": \"<string>\",\n    \"encryption_key\": \"<string>\",\n    \"username_type\": \"<string>\",\n    \"certificate\": \"<string>\",\n    \"private_key\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/links/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Precondition Required",
      "code": 428,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"code\": \"<string>\",\n\t\"message\": \"<string>\",\n\t\"request_id\": \"<uuid>\",\n\t\"session\": \"<uuid>\",\n\t\"expiry\": \"<integer>\",\n\t\"link\": \"<uuid>\",\n\t\"token_generation_data\": {\n\t\t\"instructions\": \"<string>\",\n\t\t\"type\": \"<string>\",\n\t\t\"value\": \"<string>\"\n\t}\n}"
    },
    {
      "name": "Unexpected Error",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"password\": \"<string>\",\n    \"password2\": \"<string>\",\n    \"token\": \"<string>\",\n    \"encryption_key\": \"<string>\",\n    \"username_type\": \"<string>\",\n    \"certificate\": \"<string>\",\n    \"private_key\": \"<string>\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/links/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    }
  ]
}