Pular para o conteúdo
Zoppy ConnectZoppy ConnectZoppy Connect

Quem está usando

GET
/me
curl --request GET \
  --url https://api-connect.zoppy.com.br/me \
  --header 'Authorization: Bearer <token>'

Valida o token da Zoppy, o papel (MASTER ou ADMIN) e se o Zoppy Connect está liberado para a loja; diz se o usuário já aceitou os termos atuais.

Authorizations

Seção intitulada “Authorizations”

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Loja e usuário do token

Media typeapplication/json
object
company
required

Loja do token

object
id
required

Id da loja na Zoppy

string format: uuid
name
required

Nome da loja

string
user
required

Usuário do token

object
id
required

Id do usuário na Zoppy

string
name
required
string
email
required
string
role
required
string
Allowed values: MASTER ADMIN
featureEnabled
required

O Zoppy Connect está liberado para a loja

boolean
termsAcceptedAt
required

Quando um MASTER da loja aceitou os termos atuais do Zoppy Connect; null antes do aceite

string format: date-time
nullable
termsAcceptedBy
required

Id na Zoppy do MASTER que aceitou os termos atuais pela loja; null antes do aceite

string
nullable

Example 

{
  "user": {
    "role": "MASTER"
  }
}

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”

Token restrito, sem loja, 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"
  }
}