Stripe: Go Library for The Stripe API
Choď Stripe
Oficiálna knižnica klientov Stripe Go.
Inštalácia
Uistite sa, že váš projekt používa moduly Go (ak už je, bude mať v koreňovom adresári súbor |_+_|):
|_+_|
Potom použite odkaz stripe-go v programe Go pomocou |_+_|:
|_+_|Spustite ktorýkoľvek z bežných |_+_| príkazy (|_+_|/|_+_|/|_+_|). Nástroj Go to vyrieši a načíta modul stripe-go automaticky.
Prípadne môžete aj výslovne |_+_| balík do projektu:
|_+_|Dokumentácia
Úplný zoznam príkladov nájdete v dokumentácii API .
Pozrite si video ukážky, ako používať knižnicu.
Podrobnosti o všetkých funkciách v tejto knižnici nájdete v dokumentácii Go.
Nižšie uvádzame niekoľko jednoduchých príkladov:
zákazníkov
|_+_|PaymentIntents
|_+_|Diania
|_+_|Prípadne môžete použiť |_+_| majetok uvoľniť do príslušnej štruktúry.
Autentifikácia pomocou Connect
Existujú dva spôsoby overovania požiadaviek pri vykonávaní akcií v mene pripojeného účtu, jeden, ktorý používa |_+_| hlavička obsahujúca ID účtu a hlavička, ktorá používa kľúče účtu. Zvyčajne sa odporúča prvý prístup. Ďalšie informácie nájdete v dokumentácii.
Ak chcete použiť |_+_| prístup, použite |_+_| na |_+_| alebo |_+_| trieda. Napríklad:
|_+_||_+_|Ak chcete použiť kľúč, odovzdajte ho |_+_|'s |_+_| funkcia:
|_+_|Google AppEngine
Ak používate klienta v prostredí Google AppEngine, budete si musieť vytvoriť klienta Stripe pre každú požiadavku, pretože |_+_| nie je k dispozícii. Tu je ukážkový obslužný program:
|_+_|Použitie
Zatiaľ čo niektoré zdroje môžu obsahovať viac/menej rozhraní API, v celej knižnici sa pre daný |_+_| používa nasledujúci vzor:
Bez Klienta
Ak máte čo do činenia len s jedným kľúčom, môžete jednoducho importovať balíky potrebné pre zdroje, s ktorými komunikujete, bez toho, aby ste museli vytvárať klienta.
|_+_|S klientom
Ak máte čo do činenia s viacerými kľúčmi, odporúča sa použiť |_+_|. To vám umožní vytvoriť toľko klientov, koľko potrebujete, každý s vlastným individuálnym kľúčom.
|_+_|Prístup k poslednej odpovedi
Použite |_+_| na ľubovoľnom |_+_| aby ste sa pozreli na odpoveď API, ktorá vygenerovala aktuálny objekt:
|_+_|Podobne pre |_+_| operácií, posledná odpoveď je dostupná v objekte zoznamu pripojenom k iterátoru:
|_+_|Pozri definíciu |_+_| pre dostupné polia.
Všimnite si, že tam, kde sú prostriedky API vnorené do iných prostriedkov API, iba |_+_| na zdroji najvyššej úrovne.
Automatické opakovania
Knižnica automaticky opakuje požiadavky pri občasných zlyhaniach, ako je chyba pripojenia, časový limit alebo určité odpovede API, ako je stav |_+_|. Kľúče idempotencie sa vždy pridávajú k žiadostiam, aby boli všetky takéto následné pokusy bezpečné.
V predvolenom nastavení vykoná až dva pokusy. Toto číslo je možné nakonfigurovať pomocou |_+_|:
|_+_|Konfigurácia protokolovania
V predvolenom nastavení knižnica zaznamenáva iba chybové správy (ktoré sa odosielajú na |_+_|). Nakonfigurujte predvolené protokolovanie pomocou globálneho |_+_| premenná:
|_+_|Alebo na základe jednotlivých backendov:
|_+_|Je možné použiť aj záznamníky bez pruhov. Stripe očakáva, že zapisovače budú dodržiavať nasledujúce rozhranie:
|_+_|Niektoré loggery ako Logrus a Zap's SugaredLogger podporujú toto rozhranie už prednastavené, takže je možné nastaviť |_+_| do |_+_| alebo |_+_| priamo. Pre ostatných môže byť potrebné napísať tenkú podložnú vrstvu, ktorá ich podopiera.
Rozširujúce sa objekty
Všetky rozšíriteľné objekty v stripe-go majú formu úplnej štruktúry zdrojov, ale pokiaľ sa nepožaduje rozšírenie, iba |_+_| pole tejto štruktúry je vyplnené. O rozšírenie sa žiada volaním |_+_| na štruktúre parametrov. Napríklad:
reagovať haková forma vs formik|_+_|
Písanie doplnku
Ak píšete doplnok, ktorý používa knižnicu, ocenili by sme, keby ste sa identifikovali pomocou |_+_|:
|_+_|Tieto informácie sa odovzdávajú, keď knižnica volá do Stripe API. Všimnite si, že zatiaľ čo |_+_| je vždy povinné, |_+_| a |_+_| sú voliteľné.
Požiadajte o telemetriu latencie
Knižnica štandardne odosiela telemetriu latencie žiadosti do Stripe. Tieto čísla pomáhajú Stripe zlepšiť celkovú latenciu jeho API pre všetkých používateľov.
Toto správanie môžete zakázať, ak chcete:
|_+_|rozvoj
Žiadosti o stiahnutie od komunity sú vítané. Ak ho odošlete, pamätajte na nasledujúce pokyny:
- Kód musí byť |_+_| vyhovujúci.
- Všetky typy, štruktúry a funkcie by mali byť zdokumentované.
- Uistite sa, že |_+_| uspeje.
Test
Testovacia sada potrebuje dosvedčiť |_+_| balík na spustenie:
|_+_|Pred spustením testov sa uistite, že ste získali všetky závislosti balíka:
|_+_|Závisí to aj od stripe-mock , takže sa uistite, že ho načítate a spustíte z terminálu na pozadí (súbor README stripe-mock obsahuje aj pokyny na inštaláciu cez Homebrew a ďalšie metódy):
|_+_|Spustite všetky testy:
|_+_|Spustite testy pre jeden balík:
|_+_|Spustite jeden test:
|_+_|V prípade akýchkoľvek požiadaviek, chýb alebo komentárov otvorte problém alebo odošlite žiadosť o stiahnutie .
Autor: Stripe
Zdrojový kód: https://github.com/stripe/stripe-go
Licencia: licencia MIT
#rast #api