Create credentials

POST 
/integration/credentials

JSON-RPC

integration.credentials.create

Request

application/json

Bodyrequired

companies_idintegerrequired

Partition ID.

namestringrequired

Name.

typestringrequired

Connection type.

Possible values: [ftp, ssh, sftp, imap, imap_microsoft, web, smtp]

loginstring | nullnullable

Username. Required if type is ftp, ssh, imap or web.

Possible values: <= 255 characters

Default value: null

passwordstring | nullnullable

Password. Required if type is ftp, imap or web. Additionally required for type smtp if login is provided.

Default value: null

hoststring | nullnullable

Server hostname or IP address. Required if type is ftp, ssh, imap or smtp.

Possible values: <= 255 characters

Default value: null

portinteger | nullnullable

Server port. Required if type is ftp, ssh, imap or smtp.

Possible values: >= 1 and <= 65535

Default value: null

smtp_securitystring | nullnullable

SMTP security mode. Required if type is smtp.

Possible values: [plain, tls, ssl]

Default value: null

imap_microsoft_settings object

Microsoft IMAP settings. Required if type is imap_microsoft.

client_idstringrequired

Microsoft client ID.

tenantstringrequired

Tenant name.

refresh_tokenstringrequired

Refresh token.

Responses

200

Credentials object as has been stored.

application/json

Schema

Schema

objectobject

Example (auto)

{}

400

The request contains invalid arguments or is malformed

application/json

Schema

Schema

error object
messagestring
Error message
Example: Invalid request
dataobject
Details for validation errors (if applicable)
Example: {"name":"Empty value is not allowed","payment_terms_id":"Object \"payment_terms(123)\" was not found!"}

Example (auto)

{
  "error": {
    "message": "Invalid request",
    "data": {
      "name": "Empty value is not allowed",
      "payment_terms_id": "Object \"payment_terms(123)\" was not found!"
    }
  }
}

401

Access is not authorized

application/json

Schema

Schema

error object
messagestring
Example: utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed
data object
codestring
Error code
Example: utoken-auth-failed
messagestring
Example: Authentication Failed: IP 10.0.0.1 is not allowed

Example (auto)

{
  "error": {
    "message": "utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed",
    "data": {
      "code": "utoken-auth-failed",
      "message": "Authentication Failed: IP 10.0.0.1 is not allowed"
    }
  }
}

404

Requested object was not found

application/json

Schema

Schema

error object
messagestring
Example: not_found: Object "clients(123)" was not found!
data object
codestring
Error code (static: not_found)
Example: not_found
messagestring
Error message
Example: Object "clients(123)" was not found!
object_namestring
Type of the object
Example: clients
object_idstring
ID of the object
Example: 123

Example (auto)

{
  "error": {
    "message": "not_found: Object \"clients(123)\" was not found!",
    "data": {
      "code": "not_found",
      "message": "Object \"clients(123)\" was not found!",
      "object_name": "clients",
      "object_id": "123"
    }
  }
}

422

A logical error occurred, making the request unprocessable

application/json

Schema

Schema

error object
messagestring
Error message
Example: invoices-zero-amount: Impossible to create an invoice with zero amount
data object
codestring
Error code
Example: invoices-zero-amount
messagestring
Error message
Example: Impossible to create an invoice with zero amount

Example (auto)

{
  "error": {
    "message": "invoices-zero-amount: Impossible to create an invoice with zero amount",
    "data": {
      "code": "invoices-zero-amount",
      "message": "Impossible to create an invoice with zero amount"
    }
  }
}

500

An unexpected error occurred

application/json

Schema

Schema

error object
messagestring
Error message
Example: An unexpected error occurred

Example (auto)

{
  "error": {
    "message": "An unexpected error occurred"
  }
}

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeyin: headerdescription: Token for API access

• curl
• python
• nodejs
• php

• CURL

curl -L 'https://docs.jerasoft.net/integration/credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>' \
-d '{
  "companies_id": 0,
  "name": "string",
  "type": "ftp",
  "smtp_security": "plain",
  "imap_microsoft_settings": {
    "client_id": "string",
    "tenant": "string",
    "refresh_token": "string"
  }
}'

Request Collapse all

Auth

ApiKeyAuth

Body required

{
  "companies_id": 0,
  "name": "string",
  "type": "ftp",
  "smtp_security": "plain",
  "imap_microsoft_settings": {
    "client_id": "string",
    "tenant": "string",
    "refresh_token": "string"
  }
}