Shrimpy Developer API User Flow Reference

>

Shrimpy Universal Crypto Exchange API’er er en kraftfuld ressource for applikationsudviklere af kryptokurrency. API’erne leverer løsninger på nogle af de største problemer, der opstår, når man integrerer krypto-udvekslingsfunktionalitet, herunder:

  1. Handelsudførelse med lav latens, smart ordrerute, & Automatiserede strategier

  2. Brugergodkendelse & Ledelse

  3. Exchange-integration & Endpoint Unification

  4. Realtidsdata & Analytics

At udnytte alt, hvad Shrimpy API’erne har at tilbyde, kræver en forståelse af, hvordan API’erne fungerer, og hvordan brugerne administreres. Denne reference vil guide dig gennem detaljerne i, hvordan du konceptuelt tænker på Shrimpy API’erne, diskuterer, hvordan brugerne kan administreres, og fremhæver et par af de mest almindelige anmodningsstrømme. Da vores API’er er en institutionel kvalitetsløsning designet til at muliggøre udvikling i stor skala, vil mastering af dette emne give dig mulighed for problemfrit at skalere din applikation til millioner af aktive brugere og utallige udvekslinger.

Tilmeld dig en Shrimpy API-udviklerkonto her. Glem ikke at også deltage i vores udvikler telegram for at holde dig opdateret med de seneste nyheder.

Exchange Management – Konceptuel diskussion

Dette diagram på højt niveau viser, hvordan udvikleren ikke behøver at administrere brugere direkte, udføre handler eller integrere med hver enkelt børs. Udviklere udfører kun en enkelt integration med Shrimpy API’erne for at forbinde hver af disse vigtige komponenter.

Shrimpy Universal Crypto Exchange API’er er en enkel måde for udviklere at oprette forbindelse til hver større udveksling gennem ensartede slutpunkter. Integrering af vores API’er eliminerer behovet for specialkode til hver udveksling, reducerer efterspørgslen fra sporadiske udvekslingsopdateringer, reducerer omkostningerne ved udvekslingsinfrastruktur, øger datatilgængeligheden, skalerer problemfrit til at styre et ubegrænset antal brugere, fremskynder udviklingshastigheder og standardiserer den måde, hvorpå man handler udføres på tværs af alle større udvekslinger.

Konceptuelt er Shrimpy en samlet grænseflade til hver børs. Denne grænseflade skaber en ensartet måde at styre enhver udveksling på. Uden Shrimpy API’er kan det tage uger eller endda måneder at fuldføre individuelt at integrere en udveksling. Selv efter afslutning kræver udvekslinger opdateringer og vedligeholdelse til en tilbagevendende pris uden ultimativ afslutning. Med Shrimpy API’er er udførelse af en handel på en børs identisk med udførelse af handler på hver anden børs. Vores team administrerer opgraderinger, vedligeholdelse og integrationer, så du behøver aldrig igen kæmpe for at følge med. Vores liste over understøttede børser udvides konstant og giver mulighed for øjeblikkelig integration i din applikation eller tjeneste uden yderligere arbejde.

Nogle af funktionerne, som Shrimpy tilbyder på tværs af alle større børser:

  • Data i realtid for ordrebøger

  • Valutakontosaldoer

  • Markeds ticker

  • Brugeradministration

  • Gratis Coinbase Pro- og KuCoin-handel

  • Real-time ordreudførelse

  • High-fidelity backtesting

  • Smart ordrerute

  • Automatiseret porteføljeombalancering

  • Indsigt i valg af aktiver

  • Websteds i realtid til handel og ordrebogsdata

Som applikationsudvikler er problemet forenklet til en enkelt integration med Shrimpy API’erne.

Flow af brugeranmodninger

Der er 2 primære forskellige måder, Shrimpy giver udviklere mulighed for nemt at administrere anmodninger fra brugere. Den første er en udviklerkontrolleret (centraliseret) anmodningsstrøm. Den anden metode er et brugerstyret (decentraliseret) anmodningsflow.

Ud over disse generelle brugeranmodningsstrømme diskuterer vi også mønstre for andre almindelige anmodningsstrømme, som du sandsynligvis støder på som udvikler.

Udviklerstyret (centraliseret) anmodningsflow

En udviklerstyret anmodningsstrøm betyder, at enhver anmodning, der sendes til Shrimpy, kommer fra udviklerens egne servere. I det væsentlige dirigeres hver anmodning gennem en central server, der styrer kommunikationen med Shrimpy-servere. Da udviklere kan oprette Master Shrimpy API-nøgler som administrerer hver bruger, kan udviklere sende anmodninger til Shrimpy på vegne af enhver bruger ved at underskrive anmodningerne med Master Shrimpy API Keys. Svarene på disse anmodninger kan derefter dirigeres tilbage til brugeren via den centraliserede udviklerserver.

Denne strøm er populær blandt udviklere af mobilapplikationer. Udviklere af mobilapplikationer finder, at denne anmodningsstrøm er praktisk, fordi ændringer i måden, som brugerne kommunikerer med Shrimpy på, kan justeres hurtigt. Da udvikleren kontrollerer de servere, der administrerer anmodningerne, kan opdateringer distribueres uden brugere, der opdaterer deres applikationer.

Som standard har Master Shrimpy API-nøgler en grænse på 1.000 anmodninger pr. Minut. Udviklere, der planlægger at sende tusindvis af anmodninger i minuttet, kan modtage en forhøjelse af satsgrænsen ved at maile os på [email protected]

Brug følgende trin for at implementere en udviklerkontrolleret anmodningsflow:

  1. Når en bruger tilmelder sig din applikation eller tjeneste, skal du indsamle de nødvendige oplysninger, der kræves for at registrere denne bruger hos Shrimpy. Vi anbefaler, at du inkluderer en unik identifikator som e-mail i det valgfri “navn” -felt, når du opretter en bruger med Shrimpy.

  2. Opret en ny bruger med Shrimpy. Denne handling er helt gratis, så du kan oprette så mange brugere, som du vil. Udvikleren vil kun blive opkrævet, når brugeren er “aktiveret” til handel. Rejer svarer med et unikt bruger-id. Denne anmodning skal underskrives med masternøglen.

  3. Link bruger-id Shrimpy vender tilbage til de brugeroplysninger, du har gemt i dit eget system. På denne måde kan du dirigere anmodninger fra dine brugere til Rejer korrekt.

  4. Tillad hver bruger at sende anmodninger om at linke udvekslingskonti, udføre handler, indsamle data og administrere deres portefølje. I dette anmodningsflow er du ansvarlig for at opretholde disse forbindelser med brugerne og dirigere anmodningerne korrekt til Shrimpy.

  5. Rute anmodningen til Shrimpy på vegne af hver bruger. Brug din Master Shrimpy API-nøgle til at underskrive de relevante anmodninger.

Brugerstyret (decentraliseret) anmodningsflow

Den anden mulighed for brugeranmodningsflow, der er mulig med Shrimpy-udvikler-API’erne, er en brugerstyret anmodningsflow. Dette betyder, at hver enkelt bruger administrerer sine egne anmodninger om handel, dataindsamling og sammenkædning af byttekonti ved direkte kommunikation med Shrimpy. Hver af disse anmodninger underskrives med de enkelte User Shrimpy API-nøgler. Disse er ikke det samme som Master Shrimpy API-nøgler. User Shrimpy API-nøgler er unikke for hver enkelt bruger. LEVER ALDRIG MASTER SHRIMPY API-NØGLER TIL BRUGERE.

Dette brugerflow er tilgængeligt for alle udviklere, men vi har fundet det særligt ønskeligt for webudviklere. Da websteder hurtigt kan omplaceres, er der ingen risiko for at skulle migrere brugere, hvis webstedet nogensinde skal opdateres. Fordelen ved denne anmodningsstrøm er en drastisk reduktion af serverbelastningen.

Ovenstående diagram illustrerer, hvordan udviklere, der implementerer denne anmodningsstrøm, stadig har brug for en central server til at starte oprettelsen af ​​brugere. Ud over oprettelsen af ​​brugeren skal udvikleren også generere Shrimpy User API-nøgler til hver enkelt bruger. Disse nøgler sendes tilbage til brugeren, så de kan kommunikere direkte med Shrimpy ved at underskrive anmodninger om at få adgang til deres personlige konto.

Implementering af det brugerstyrede anmodningsflow vil kræve følgende trin:

  1. Når en bruger tilmelder sig din applikation eller tjeneste, skal du indsamle de nødvendige oplysninger, der kræves for at registrere denne bruger hos Shrimpy. Vi anbefaler, at du inkluderer en unik identifikator som e-mail i det valgfri “navn” -felt, når du opretter en bruger med Shrimpy.

  2. Opret en ny bruger med Shrimpy. Denne handling er helt gratis, så du kan oprette så mange brugere, som du vil. Udvikleren vil kun blive opkrævet, når brugeren er “aktiveret” til handel. Rejer svarer med et unikt bruger-id. Denne anmodning skal underskrives med masternøglen.

  3. Anmodning om at oprette Shrimpy User API-nøgler til denne bruger. Disse nøgler er unikke for hver enkelt bruger og kan kun underskrive anmodninger om den tilknyttede brugerkonto. Anmodningen om at generere disse nøgler er underskrevet af Master Shrimpy API-nøgler.

  4. Ret Shrimpy User API-nøgler og bruger-ID tilbage til den relevante bruger. Disse nøgler bruges til direkte kommunikation med Shrimpy.

  5. Hver af dine individuelle brugere kan nu kommunikere direkte med Shrimpy ved at underskrive anmodninger med Shrimpy User API Keys. Brugere kan udføre handler, indsamle data, linke udvekslingskonti, administrere deres portefølje, køre backtests og mere ved at underskrive anmodninger med deres individuelle nøgler.

Forbinder Exchange-konto

Den følgende diskussion vil fokusere på anmodningsflowet for at linke byttekonti til en bruger og udføre en handel. Selvom dette diagram er specifikt for den brugerstyrede anmodningsflow, er processen stort set den samme for en udviklerstyret anmodningsflow. Den største forskel er, at anmodningerne underskrives med Master Shrimpy API-nøgler, når du bruger det udviklerkontrollerede anmodningsflow.

Når en bruger modtager deres Shrimpy User API-nøgler, kan de kommunikere direkte med Shrimpy for at linke udvekslinger, udføre handler, indsamle data og mere. Processen til generering af en Shrimpy User API-nøgle er beskrevet i afsnittet med titlen “Brugerstyret (decentraliseret) anmodningsflow”.

For at begynde at udføre handler på en børs, skal du først linke en byttekonto til brugeren. Dette kan gøres gennem følgende trin:

  1. Link brugerens Exchange API-nøgler til Shrimpy ved hjælp af “Link en Exchange-konto”Slutpunkt. Exchange API-nøgler er ikke de samme som Shrimpy User API-nøgler. Exchange API-nøgler opnås og konfigureres på børsen. Disse nøgler er specifikke for hver udvekslingskonto. Denne anmodning skal underskrives med Shrimpy User API Keys.

  2. Shrimpy kommunikerer med børsen for at verificere udvekslingskontoen, indsamle data og administrere forbindelsen.

  3. Når verifikationen er afsluttet, vil Shrimpy svare med et konto-id for den udvekslingskonto, der er blevet linket. En bruger har lov til at linke op til 20 udvekslingskonti, så dette konto-id er den måde, Shrimpy identificerer hver udvekslingskonto på. Hvis dine brugere har brug for at linke mere end 20 udvekslingskonti, bedes du kontakte os på [email protected]

  4. Brugeren kan nu anmode Shrimpy om at udføre handler, linke flere udvekslingskonti, køre backtests og mere. Disse anmodninger skal underskrives med Shrimpy User API Keys.

Tildeling af brugerportefølje og genbalancering

Den følgende diskussion vil fokusere på anmodningsflowet for tildeling af en portefølje og opsætning af en periodisk rebalance for en bruger, der allerede har knyttet en vekselkonto til Shrimpy. Selvom dette diagram er specifikt for den brugerstyrede anmodningsflow, er processen stort set den samme for en udviklerstyret anmodningsflow. Den største forskel er, at anmodningerne underskrives med Master Shrimpy API-nøgler, når du bruger det udviklerkontrollerede anmodningsflow.

Når en bruger har tilsluttet en udvekslingskonto ved hjælp af trinnene beskrevet i “Forbinder Exchange-konto”, De kan allokere en portefølje og oprette en strategi.

Bemærk: Anmodningsflowet for simpelthen at placere grænseordrer, smarte ordrer eller indsamle data er forskelligt fra dette anmodningsflow. Ingen portefølje eller strategi skal indstilles for at kunne afgive begrænsede ordrer, udføre smarte ordrer eller indsamle data; en udvekslingskonto skal dog stadig tilknyttes.

Processen for tildeling af en portefølje og oprettelse af en genbalanceringsstrategi med Shrimpy er som følger:

  1. Send porteføljetildelingen til Shrimpy. Denne anmodning er underskrevet med Shrimpy User API Keys.

  2. Anmod om genbalance. En rebalance i dette tilfælde vil simpelthen udføre de handler, der er nødvendige for at konstruere den portefølje, der blev specificeret i trin 1. Denne anmodning skal underskrives med Shrimpy User API Keys.

  3. Shrimpy kommunikerer derefter med børsen for at indsamle data, udføre handlerne og konstruere den ønskede portefølje.

  4. Anmod med jævne mellemrum om status for genbalancering ved at kalde “List Accounts” slutpunktet. Brugeren kan også følge op med flere anmodninger om at udføre handler, indsamle balancedata, få adgang til de nyeste markedsdata og mere. Disse anmodninger er underskrevet med Shrimpy User API Keys.

Konklusioner

Shrimpy API’erne er en fleksibel mulighed for applikationsudviklere, der søger en skybaseret løsning, der løser store forhindringer for udveksling af handel, dataindsamling, produkts skalerbarhed og brugeradministration. Integrer hver større børs med ensartede slutpunkter ved at udnytte vores universelle infrastruktur for handel med kryptobørs. Forenkle dine brugeranmodningsflow ved at drage fordel af vores nye designmønstre. Skaler din service til millioner af brugere uden bekymring.

relaterede artikler

Rejer vs CCXT: Sagen om centralisering i et decentraliseret økosystem

Handel med Crypto Through API’er

Universelle websockets til realtidsdata om krypto-udveksling af ordrebøger

Historiske OHLCV-handelskortdata for Crypto-udvekslinger

Crypto API til Smart Order Routing

Mike Owergreen Administrator
Sorry! The Author has not filled his profile.
follow me