Code Monkey home page Code Monkey logo

api's Introduction

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

api's People

Contributors

etic-sus avatar spyei avatar yunreal avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

etic-sus

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.