Connect.aiCentral de Ajuda

šŸ‘„ UsuĆ”rios

POST /v2/api/external/{apiId}/createUser

CreateUser

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ‘„ UsuĆ”rios"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/createUser":{"post":{"tags":["šŸ‘„ UsuĆ”rios"],"summary":"CreateUser","operationId":"CreateUser","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email do usuĆ”rio"},"password":{"type":"string","description":"Senha do usuĆ”rio (mĆ­nimo 8 caracteres)"},"name":{"type":"string","description":"Nome completo do usuĆ”rio"},"profile":{"type":"string","description":"Perfil do usuĆ”rio (admin, user)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/getUserStatus

GetUserStatus

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ‘„ UsuĆ”rios"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/getUserStatus":{"get":{"tags":["šŸ‘„ UsuĆ”rios"],"summary":"GetUserStatus","operationId":"GetUserStatus","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"userId","in":"query","required":false,"description":"ID do usuĆ”rio","schema":{"type":"integer"}}],"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

GET /v2/api/external/{apiId}/listUsers

ListUsers

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ‘„ UsuĆ”rios"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listUsers":{"get":{"tags":["šŸ‘„ UsuĆ”rios"],"summary":"ListUsers","operationId":"ListUsers","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"pageNumber","in":"query","required":false,"description":"NĆŗmero da pĆ”gina","schema":{"type":"integer"}}],"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

POST /v2/api/external/{apiId}/updateUser

UpdateUser

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"šŸ‘„ UsuĆ”rios"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"DomĆ­nio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/updateUser":{"post":{"tags":["šŸ‘„ UsuĆ”rios"],"summary":"UpdateUser","operationId":"UpdateUser","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer","description":"ID do usuĆ”rio que serĆ” atualizado"},"name":{"type":"string","description":"Nome completo do usuĆ”rio (opcional)"},"email":{"type":"string","description":"Email do usuĆ”rio (opcional)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"ParĆ¢metros invĆ”lidos ou faltando."},"401":{"description":"Token ausente, invĆ”lido ou sem permissĆ£o."}}}}}}

Este artigo foi Ćŗtil?