Skip to main content
A API do X v2 é projetada com padrões consistentes em todos os endpoints. Uma vez que você aprende como um endpoint funciona, os mesmos padrões se aplicam em todos os lugares.

Padrões consistentes

Estrutura da URL

Todos os endpoints v2 seguem um padrão previsível:
Exemplos:

Estrutura da resposta

Todas as respostas usam a mesma estrutura de nível superior:

Formato de ID

Todos os IDs são retornados como strings para garantir compatibilidade entre linguagens:

Fields e expansions

Os mesmos parâmetros fields e expansions funcionam de forma consistente:

Esquemas de objetos

O mesmo tipo de objeto tem os mesmos campos independentemente de qual endpoint o retorne:
  • Um Post da pesquisa tem os mesmos campos de um Post do lookup
  • Um User dos followers tem os mesmos campos de um User da pesquisa
  • Objetos expandidos correspondem aos seus equivalentes independentes

Autenticação

Todos os endpoints usam os mesmos métodos de autenticação:

Tratamento de erros

Os erros seguem um formato consistente:
Veja todos os tipos de erro →

Paginação

Todos os endpoints paginados usam o mesmo sistema de tokens: Saiba mais sobre paginação →

Convenções de nomenclatura

  • Grafia em inglês americano (favorites e não favourites)
  • Snake_case para nomes de campos (author_id, created_at)
  • Terminologia consistente (retweet_count, não repost_count em campos)

Valores vazios

Campos sem valor são omitidos em vez de retornados como null:

Consistência de entidades

O objeto entities contém apenas entidades analisadas a partir do texto:
  • urls
  • hashtags
  • mentions
  • cashtags
Mídia e enquetes ficam em attachments, não em entities.

O que isso significa para você

Aprenda uma vez, use em todo lugar

Padrões que você aprende em um endpoint se aplicam a todos.

Respostas previsíveis

Os mesmos tipos de objeto têm as mesmas estruturas em toda a API.

Código mais simples

Construa funções reutilizáveis para padrões comuns.

Depuração mais fácil

Formatos de erro consistentes simplificam a solução de problemas.

Relate inconsistências

Encontrou uma inconsistência? Avise-nos: