Pular para o conteúdo
Zoppy ConnectZoppy ConnectZoppy Connect

Sistema do catálogo

GET
/connect/systems/{systemId}
curl --request GET \
  --url https://api-connect.zoppy.com.br/connect/systems/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Um sistema do catálogo.

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
systemId
required

Id do sistema no catálogo

string format: uuid

Id do sistema no catálogo

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Sistema

Media typeapplication/json
object
id
required

Id do sistema

string format: uuid
slug
required

Nome curto e estável

string
name
required

Nome do sistema

string
description
required

O que é o sistema, em uma linha em português

string
nullable
category
required

Categoria

string
Allowed values: erp ecommerce finance marketing helpdesk database other
runsOn
required

Cloud ou local_agent

string
Allowed values: cloud local_agent
accessKind
required

Como a loja dá acesso

string
Allowed values: token key_secret user_password database
official
required

Se a plataforma mantém o sistema (a Zoppy é)

boolean
nativeIntegration
required

Se a Zoppy já integra o sistema nativamente: a IA avisa antes de escrever o mesmo recurso

boolean
logoUrl
required

Caminho do logo servido pelo Connect, com a versão dele; null quando não tem

string
nullable
hosts
required

Hosts já conhecidos do sistema

Array<string>
docsUrl
required

Documentação oficial

string
nullable
worthBringing
required

O que costuma valer a pena trazer dele

Array<string>
usageCount
required

Quantas lojas têm um conector ligado com este sistema; só a contagem

integer
comingSoon
required

Aparece no catálogo, mas ainda não aceita conectores

boolean
oauthOnly
required

O sistema só dá acesso por OAuth, que o Connect ainda não suporta

boolean

Example 

{
  "category": "erp",
  "runsOn": "cloud",
  "accessKind": "token"
}

400

Seção intitulada “400”

Entrada inválida (validation_failed)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

401

Seção intitulada “401”

Token ausente, inválido ou expirado (connect.unauthorized)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

403

Seção intitulada “403”

Papel sem acesso ou Connect não liberado (connect.forbidden_role, connect.feature_disabled)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

404

Seção intitulada “404”

Sistema fora do catálogo (connect.system_not_found)

Media typeapplication/json
object
type
required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string
title
required

Nome da classe do erro

string
status
required

Status HTTP

integer
detail
required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string
requestId
required

Id de correlação: passe ao suporte para achar o rastro completo

string
nullable
meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object
key
additional properties

Example generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}