Providerhandleidingen
Convoy: instellen en beheren
Een experimentele adapter met verbindings- en productschema voor Convoy.
Op deze pagina
Werkwijze bij de provider
Een experimentele adapter met verbindings- en productschema voor Convoy. Het pakket hoort bij Provisioning, maar is niet beschikbaar voor productielevering. Het voorlopige productschema bevat template_id, region, plan. Deze vermelding beschrijft de pakketbron en is geen aanbod van werkende geautomatiseerde hosting.
Vereisten
Agovena Core ^0.0.1. Activeer Provisioning vóór deze uitbreiding.
Deze uitbreiding is niet als productierijp gemarkeerd. Controleer de ondersteunde werkwijze in je eigen testomgeving voordat je klantbestellingen aanneemt.
Het pakket instellen
Laat de uitbreiding uitgeschakeld voor klantproducten. Activeer in een geïsoleerde ontwikkelinstallatie eerst Provisioning en bekijk de gedeclareerde Convoy-verbindingsvelden. Bewaar API-gegevens uitsluitend in beschermde serverinstellingen en laat verify_tls aan. De verbindingstime-out staat standaard op 20 seconden. Stuur geen echte klantbestellingen naar deze adapter.
Providerspecifieke grenzen
Het concept vereist organization_id naast het verbindingstoken. Productvelden zijn template_id, region en plan. De officiële Convoy Application API-handleiding beschrijft bearer-authenticatie. De adapter erft echter nog generieke health- en serverpaden. Gebruik documentatie van Convoy Panel, niet van het gelijknamige vrachtplatform.
Het onderstaande configuratiecontract helpt ontwikkelaars de koppeling voor te bereiden. Het is geen productiehandleiding. Verplichte velden beschrijven het voorlopige verbindingsformulier. De genoemde productvelden hebben in hun definities geen verplichte validatie. De gedeelde client gebruikt /api/health voor de verbindingstest. Een groen antwoord test geen accountaanmaak, eigendomscontrole, annulering of resourceadministratie.
Voordat je deze provider aan klanten aanbiedt, moet een providerspecifieke implementatie de geblokkeerde levenscyclus vervangen en correcte verzoeken, antwoordcontrole, eigendom en herstel aantonen. Gebruik intussen een handmatig leveringsproces of een afzonderlijk gevalideerde adapter. Omzeil de blokkade niet, zet TLS-controle niet uit en wijzig de API-URL niet naar een andere dienst om alleen de healthcheck te laten slagen. 2
Configuratiecontract
| Veld | Type | Verplicht | Geheim | Standaard |
|---|---|---|---|---|
api_url |
string |
Ja | Nee | Leeg |
api_token |
string |
Ja | Ja | Leeg |
organization_id |
string |
Ja | Nee | Leeg |
verify_tls |
boolean |
Nee | Nee | true |
timeout |
string |
Nee | Nee | "20" |
Dit zijn de velden uit het manifest. Een optioneel veld kan voor een API-handeling toch noodzakelijk zijn, zoals hierboven beschreven. Bewaar geheime waarden alleen in beschermde instellingen, nooit in productbeschrijvingen, URL’s of gedeelde voorbeelden. 1
Werking en foutafhandeling
Provisioning, activeren, opschorten, hervatten, verwijderen, planwijzigingen, statussynchronisatie en paneelacties geven via de gedeelde basisklasse bewust een validatiefout voor een niet-ondersteunde handeling. Ook capaciteitscontrole wordt niet ondersteund door de gedeelde HTTP-client. Een verbindingstest kan wel draaien, maar activeert deze handelingen niet en bewijst geen compatibiliteit met de provider-API.