Get Tools Lab Entwicklungs-API
Integrieren Sie veröffentlichte Tools, Leitfäden und Plattform-Workflows mithilfe authentifizierter Entwicklerendpunkte. Die verfügbaren Funktionen hängen von den aktivierten API-Modulen und Ihrer Zugriffsebene ab.
API-Optionen
Die Plattform umfasst REST-Endpunkte und eine leichte GraphQL-kompatible Schicht mit Unterstützung für API-Schlüssel, OAuth-Client-Anmeldeinformationen, Nutzungsanalysen, Ratenbegrenzungen und signierte Webhook-Zustellung. Nicht jede Funktion einer öffentlichen Website ist automatisch über die API verfügbar.
Authentifizierung
REST v1-Endpunkte können einen API-Schlüssel im verwenden X-API-Key -Header. Neuere Endpunkte akzeptieren möglicherweise auch unterstützte Inhabertoken. Halten Sie alle Zugangsdaten geheim und tauschen Sie einen Schlüssel sofort aus, wenn er offengelegt wird.
curl -H "X-API-Key: qc_your_key" "https://gettoolslab.com/api/v1/tools.php"
Gemeinsame REST-Endpunkte
Werkzeuge
GET /api/v1/tools.php
GET /api/v1/tools.php?category=PDF
GET /api/v1/tools.php?q=json
Leitfäden
GET /api/v1/guides.php
GET /api/v1/guides.php?q=image
REST v2 und GraphQL
Die konsolidierte Entwicklerplattform kann neuere REST-Routen und GraphQL-Operationen für unterstützte Ressourcen verfügbar machen. Verwenden Sie den Entwicklungsbereich und den API-Playground, um die Endpunkte anzuzeigen, die in der aktuellen Bereitstellung tatsächlich aktiviert sind.
Ratenbegrenzungen
API-Anfragen können pro Minute oder pro Tag begrenzt sein. Eine Anfrage, die ihr Limit überschreitet, kann HTTP zurückgeben 429 Too Many Requests zusammen mit Informationen zum erneuten Versuch oder Zurücksetzen. Anwendungen sollten Backoff verwenden, anstatt fehlgeschlagene Anforderungen sofort zu wiederholen.
Webhooks
Unterstützte Ereignisse können an ein HTTPS-Webhook-Ziel übermittelt werden. Wenn die Signatur aktiviert ist, überprüfen Sie die HMAC-Signatur, bevor Sie der Nutzlast vertrauen. Ein Webhook-Konsumer sollte auch Wiederholungsversuche tolerieren und die Ereignisverarbeitung idempotent machen, damit dieselbe Zustellung keine doppelten Aktionen erzeugt.
Fehler
Ungültige Anmeldeinformationen, deaktivierte Clients, erschöpfte Kontingente oder fehlerhafte Anforderungen können strukturierte JSON-Fehler mit HTTP 4xx-Statuscodes zurückgeben. Serverseitige Fehler verwenden 5xx-Antworten. Anwendungen sollten den Antwortstatus und die Anforderungskennung protokollieren, sofern verfügbar, anstatt geheime Anmeldeinformationen in Fehlerberichten preiszugeben.
Sicherheit guidance
- Betten Sie niemals geheime API-Schlüssel in öffentliches Browser-JavaScript ein.
- Verwenden Sie HTTPS für API- und Webhook-Verkehr.
- Geben Sie Clients nur die Berechtigungen, die sie benötigen.
- Webhook-Signaturen validieren.
- Kompromittierte Anmeldeinformationen rotieren.
- Beachten Sie dokumentierte Ratenbeschränkungen und Dateigrößenbeschränkungen.
SDKs und Spielplatz
Besuchen Sie den Abschnitt „Entwicklung“ für SDK-Beispiele und den interaktiven Spielplatz. Testen Sie Integrationen mit nicht sensiblen Daten, bevor Sie Produktionsdateien oder Kundeninformationen verwenden.