Documentation de l'API IndexJump

Intégrez une indexation rapide dans votre flux de travail grâce à notre puissante API REST

IndexJump fournit des services d'indexation rapide pour Google, Bing et d'autres moteurs de recherche. L'API est accessible via quatre points de terminaison, vous permettant de gérer votre file d'attente d'indexation et de suivre la progression en temps réel.

Authentification

Toutes les requêtes API nécessitent un paramètre « token » pour l'authentification. Incluez votre jeton API dans chaque requête en tant que paramètre de requête ou dans le corps de votre requête.

Votre token est unique à votre compte et doit rester confidentiel. Ne le partagez jamais publiquement et ne le confiez jamais au contrôle de version.

Connectez-vous ou créez un compte pour afficher votre jeton API.

Commencer

Points de terminaison de l'API

GET

Obtenez l'équilibre

https://api.indexjump.com/balance

Récupérez le nombre d'URL disponibles dans votre compte pour l'indexation.

Paramètres

token Requis Votre jeton d'authentification API

Exemple de demande

curl -X GET "https://api.indexjump.com/balance?token=YOUR_TOKEN"

Réponse réussie (200)

{
  "err": null,
  "res": {
    "balance": 74
  }
}
POST

Soumettre une URL pour l'indexation

https://api.indexjump.com/index

Soumettez une seule URL à indexer par les moteurs de recherche.

Paramètres

url Requis L'URL à indexer
token Requis Votre jeton d'authentification API
bot Facultatif Cible du moteur de recherche : 0 (GoogleBot), 1 (OpenAIBot), 2 (BingBot). Par défaut : 0

Exemple de demande

curl -X GET "https://api.indexjump.com/index?url=https%3A%2F%2Fexample.com&token=YOUR_TOKEN"

Réponse réussie (200)

{
  "err": null,
  "res": {
    "success": true
  }
}
POST

Soumission groupée d'URL pour l'indexation

https://api.indexjump.com/index/bulk

Soumettez plusieurs URL dans une seule demande d’indexation par lots.

En-têtes

Content-Type application/json

Paramètres du corps

urls Requis Tableau d'URL à indexer
token Requis Votre jeton d'authentification API
bot Facultatif Cible du moteur de recherche : 0 (GoogleBot), 1 (OpenAIBot), 2 (BingBot). Par défaut : 0

Exemple de demande

curl -X POST "https://api.indexjump.com/index/bulk?token=YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example1.com",
      "https://example2.com"
    ]
  }'

Réponse réussie (200)

{
  "err": null,
  "res": {
    "success": true
  }
}
GET

Vérifier l'état de l'indexation

https://api.indexjump.com/index/status

Vérifiez l'état d'indexation actuel et affichez les journaux du robot d'exploration pour une URL soumise.

Paramètres

url Requis L'URL pour laquelle vérifier l'état d'indexation
token Requis Votre jeton d'authentification API
bot Facultatif Cible du moteur de recherche : 0 (GoogleBot), 1 (OpenAIBot), 2 (BingBot). Par défaut : 0

Exemple de demande

curl -X GET "https://api.indexjump.com/index/status?url=https%3A%2F%2Fexample.com&token=YOUR_TOKEN"

Réponse réussie (200)

{
  "err": null,
  "res": {
    "success": true,
    "status": "Delivered",
    "log_visit": "September 3, 2024, 11:25 am (UTC +0) --- GET --- 66.249.78.3"
  }
}

Valeurs d'état

  • Delivered - Le robot a été livré ; L'URL sera bientôt indexée
  • In progress - Livraison du bot actuellement en cours
  • In queue - URL mise en file d'attente pour la livraison par le bot
  • Not found - URL introuvable dans votre compte

Codes d'état HTTP

200

D'ACCORD

Demande réussie

400

Mauvaise demande

Paramètres invalides ou demande mal formée

401

Non autorisé

Jeton API manquant ou invalide

429

Trop de demandes

Limite de débit dépassée. Veuillez réessayer après un certain délai

FAQ sur les API

Y a-t-il une limite de taux ?

Oui, les points de terminaison de l'API ont des limites de débit pour garantir une utilisation équitable. Les limites standard sont de 100 requêtes par minute et par jeton. Contactez l’assistance pour des limites plus élevées.

Combien de temps faut-il pour qu'une URL soit indexée ?

Après la soumission, les robots des moteurs de recherche visitent généralement dans les 24 à 48 heures. L'indexation finale dans l'index principal prend en moyenne 1 à 3 semaines, en fonction de la qualité du contenu et de l'autorité du site.

Puis-je utiliser l'API avec des webhooks ?

Actuellement, l'API ne prend pas en charge les webhooks. Utilisez le point de terminaison d'état pour rechercher des mises à jour ou consultez votre tableau de bord pour une surveillance en temps réel.

Que se passe-t-il si une URL échoue ?

Si l’indexation échoue, vérifiez le point de terminaison d’état pour obtenir des informations détaillées sur l’erreur. Les problèmes courants incluent des URL non valides, des directives noindex ou des erreurs de serveur. Notre équipe d'assistance peut vous aider à diagnostiquer les problèmes.

L'accès à l'API est-il disponible sur les forfaits gratuits ?

Oui, l'accès à l'API est inclus dans le forfait gratuit. Le forfait gratuit comprend 100 URL pour l'indexation.

Comment gérer les erreurs ?

Toutes les réponses incluent un champ « erreur ». Si «err» est nul, la requête a réussi. Sinon, vérifiez le message d'erreur pour plus de détails et réessayez de manière appropriée.

Prêt à automatiser votre indexation ?

Commencez à utiliser l'API dès aujourd'hui avec votre essai gratuit de 100 URL. Aucune carte de crédit requise.

Obtenez votre jeton API