API

Simo API é uma API baseada em HTTP/REST para serviços em geral relacionada com Simo.

Base URL

https://simobotlist.online

Autenticação

A autenticação pode ser feita de duas maneiras:

1. Usando Json Web Token (método menos comum, geralmente usada no front-end)
2. Usando uma api-key gerada no site Simo botlist

Todas as autenticações devem ser colocada no cabeçalho Authorization em uma requisição HTTP.

Caso use Json Web Token, use o prefixo User antes do Json Web Token.
Caso use api-key, use o prefixo Bot antes da api-key.

Exemplo

Usando API key

{
    "Authorization": "Bot 0jija6272bfda-e4jb2bj6bje5c-2icdeg51ee0jb"
}

Usando JSON Web Token (JWT)

{
    "Authorization": "User eyJhbGciOiJIUzI1NiJ9.UG9yIHF1ZSB2b2PDqiB0ZW50b3UgZGVjb2RpZmljYXIgaXNzbz8.cXaza7vgMrvJR0MXihfaSh7eJUXzsFdmK-b4c_8dEZg"
}

Eventos

A Simo API suporta uma variedade de eventos usando socket, visite a documentação para saber mais.

Tipos

Comos os tipos são documentados? Os tipos seguem o padrão do TypeScript. Alguns campos podem conter o valor null, e alguns campos podem ser opicionais.

Exemplos De Campos anuláveis e opcionais

NAME	TYPE
anulável	?string
opcional?	string
campo_normal	string

Datas

Sempre quando necessário salvar a data de criação/atualização de algo, é utilizado datas ISO8601.

Erros

Erros talvez possam ter a propriedade errors e alguns não. Erros são feitos para ser legível por humanos. Em quase cada nova atualização um erro é adicionado (você pode ver eles em errors). Exemplo de erros:

Erro normal:

{
    "message": "Unknown user",
    "code": 5001
}

Erros com errors:

{
    "errors": ["Not a well-formed image URL"]
}

Query String Params

Algumas rotas da API usam parâmetros de string de consulta que aceitam números e booleanos. Como não existe nenhum padrão para eles, a Simo API usa true e 1 para representar valores verdadeiros, e false (e 0) para valores falsos e qualquer número inteiro para números.

Locales

Todas as linguagens disponíveis que um usuário pode escolher.

NAME	LANGUAGE NAME
pt-BR	Portuguese, Brazilian
en-US	English, US
es-ES	Spanish, ES

simoworkspace / api

API