X.gd Developers

Fornecemos uma API para encurtar URLs de aplicativos externos. Uma chave API é necessária para usar a API.

API de encurtamento de URL

Shorten API v1.0

GET https://xgd.io/V1/shorten

Solicitação

*ParameterTypeFormatDescriptionExample
*urlStringhttp(s)://URL a encurtarhttps://example.com
shortidString[0-9a-zA-Z_]{6,15}URL curta personalizada. Atribuição aleatória se omitidaexample
analyticsStringtrue / falseAtivar análise de acesso. Ativado se omitidotrue
filterbotsStringtrue / falseFiltragem de bots quando a análise está ativada. Desativado se omitidofalse
*keyString[0-9a-f]{32}Chave API emitida0af50e06255c7004f9ad71338f5ad56e
Exemplo de solicitação (URL)
https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}
Exemplo de solicitação (cURL)
curl -X GET 'https://xgd.io/V1/shorten?url=https://example.com&key={Your API Key}'

Resposta (Sucesso)

*ParameterTypeFormatDescriptionExample
*statusNumber200Código de status200
*shorturlStringhttps://x.gd/[0-9a-zA-Z_]+URL encurtadahttps://x.gd/example
*analyticsBooleantrue / falseAnálise de acessotrue
*filterbotsBooleantrue / falseFiltragem de botsfalse
*originalurlStringhttp(s)://URL originalhttps://example.com
Exemplo de resposta
status: 200
content-type: application/json

{
    "status": 200,
    "shorturl": "https://x.gd/example",
    "analytics": true,
    "filterbots": false,
    "originalurl": "https://example.com/"
}

Resposta (Falha)

*ParameterTypeFormatDescriptionExample
*statusNumber400 / 401 / 403 / 409 / 429 / 500 / 503Código de status429
*messageString-Mensagem de erroToo many requests.
Exemplo de resposta
status: 200
content-type: application/json

{
    "status": 429,
    "message": "Too many requests."
}

Código de status

StatusDescription
200A resposta é normal.
400Ocorreu um erro na solicitação. A mensagem contém detalhes.
401O token não é válido. Verifique sua chave API.
403Temporariamente ou permanentemente indisponível.
409Impossível emitir URL encurtada nas condições solicitadas. A mensagem contém detalhes.
429Limite de uso da API atingido. Aguarde até que o limite seja levantado e tente novamente.
500Ocorreu um erro de sistema temporário. Tente novamente após algum tempo.
503O serviço está temporariamente indisponível. Tente novamente após algum tempo.

Chave API

Enviaremos uma URL para emitir uma chave API para o endereço de e-mail que você forneceu.
Você deve concluir o procedimento dentro de 24 horas após o envio.