Pular para o conteúdo principal
POST
/
platform
/
api
/
v1
/
users
Criar a User
curl --request POST \
  --url https://airys.chat/platform/api/v1/users \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "Daniel",
  "display_name": "Dan",
  "email": "daniel@acme.inc",
  "password": "Password2!",
  "custom_attributes": {}
}
'
import requests

url = "https://airys.chat/platform/api/v1/users"

payload = {
"name": "Daniel",
"display_name": "Dan",
"email": "daniel@acme.inc",
"password": "Password2!",
"custom_attributes": {}
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Daniel',
display_name: 'Dan',
email: 'daniel@acme.inc',
password: 'Password2!',
custom_attributes: {}
})
};

fetch('https://airys.chat/platform/api/v1/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://airys.chat/platform/api/v1/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Daniel',
'display_name' => 'Dan',
'email' => 'daniel@acme.inc',
'password' => 'Password2!',
'custom_attributes' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://airys.chat/platform/api/v1/users"

payload := strings.NewReader("{\n \"name\": \"Daniel\",\n \"display_name\": \"Dan\",\n \"email\": \"daniel@acme.inc\",\n \"password\": \"Password2!\",\n \"custom_attributes\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("api_access_token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://airys.chat/platform/api/v1/users")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Daniel\",\n \"display_name\": \"Dan\",\n \"email\": \"daniel@acme.inc\",\n \"password\": \"Password2!\",\n \"custom_attributes\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/platform/api/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Daniel\",\n \"display_name\": \"Dan\",\n \"email\": \"daniel@acme.inc\",\n \"password\": \"Password2!\",\n \"custom_attributes\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "access_token": "<string>",
  "account_id": 123,
  "available_name": "<string>",
  "avatar_url": "<string>",
  "confirmed": true,
  "display_name": "<string>",
  "message_signature": "<string>",
  "email": "<string>",
  "hmac_identifier": "<string>",
  "inviter_id": 123,
  "name": "<string>",
  "provider": "<string>",
  "pubsub_token": "<string>",
  "ui_settings": {},
  "uid": "<string>",
  "type": "<string>",
  "custom_attributes": {},
  "accounts": [
    {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "active_at": "2023-11-07T05:31:56Z",
      "permissions": [
        "<string>"
      ],
      "availability": "<string>",
      "availability_status": "<string>",
      "auto_offline": true,
      "custom_role_id": 123,
      "custom_role": {}
    }
  ]
}
{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido pelo administrador do sistema após a criação de um platformApp. Este token deve ser usado para provisionar bot de agentes, contas, usuários e suas funções.

Corpo

application/json
name
string

Nome do usuário

Exemplo:

"Daniel"

display_name
string

Nome de exibição do usuário

Exemplo:

"Dan"

email
string

E-mail do usuário

Exemplo:

"daniel@acme.inc"

password
string

A senha deve conter letras maiúsculas, minúsculas, número e um caractere especial

Exemplo:

"Password2!"

custom_attributes
object

Atributos personalizados que você deseja associar ao usuário

Exemplo:
{}

Resposta

Sucesso

id
number
access_token
string
account_id
number
available_name
string
avatar_url
string
confirmed
boolean
display_name
string | null
message_signature
string | null
email
string
hmac_identifier
string
inviter_id
number | null
name
string
provider
string
pubsub_token
string
role
enum<string>
Opções disponíveis:
agent,
administrator
ui_settings
object
uid
string
type
string | null
custom_attributes
object

Disponível para usuários criados por meio das APIs da plataforma e que possuem atributos personalizados associados.

accounts
object[]