OrbitSenderDocs
ReferenceIntegrações

Criar integração

POST
/api/external/create-integrations

⚠️ Fase 2 — hoje responde HTTP 501 (não implementado).

Cria uma integração de marketplace. Os campos de credentials variam por type. Uma integração por tipo. mercadolivre e shein não são aceitos: são criados pela extensão do navegador (as credenciais vêm da sessão do usuário, não de campos digitáveis).

Authorization

ApiKeyAuth
x-api-key<token>

Chave de API no formato sk_live_..., no header x-api-key.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/external/create-integrations" \  -H "Content-Type: application/json" \  -d '{    "type": "shopee",    "label": "Minha loja Shopee",    "credentials": {      "appId": "123456",      "appSecret": "abcdef"    }  }'
{  "success": true,  "message": "string",  "integration": {    "id_integration": "amazon",    "label": "string",    "configured": true,    "fields": {      "property1": true,      "property2": true    },    "updated_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z"  }}
{  "success": false,  "error": "Bad Request",  "message": "O campo \"name\" é obrigatório no body da requisição."}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Conflict",  "message": "Este grupo já está configurado como monitoramento para este segmento."}
{  "success": false,  "error": "Too Many Requests",  "code": "rate_limited",  "message": "Muitas requisições. Tente novamente em instantes."}
{  "success": false,  "error": "Internal Server Error",  "message": "Erro interno ao processar a requisição."}
{  "success": false,  "error": "Not Implemented",  "code": "not_implemented",  "message": "Endpoint em implementação (Fase 2)."}