Forbind Semaphore til dine værktøjer

Brug en webhook-integration, når en ekstern hændelse skal vælge en foruddefineret opgaveskabelon og mappe anmodningsværdier til accepterede input. Brug REST-API'et, når applikationen kræver et mere eksplicit ressource- og eksekveringsforløb, såsom at starte en opgave og læse status. I begge tilfælde kører automatiseringen via Semaphores konfigurerede eksekveringsmodel. Vælg efter kalderens behov for at sende og følge data.

Et projekt-alias evaluerer de konfigurerede matchers på tværs af sine integrationer og kan starte dem, der matcher anmodningen. Et integrationsspecifikt alias henvender sig direkte til én integration uden at evaluere dens matchers. Det har betydning, hvis du forventer, at en regel for branch eller hændelsestype styrer eksekveringen. Vælg endpoint bevidst, og test både matchende og ikke-matchende payloads i stedet for at antage, at samme filter gælder for alle alias-stier.

Konfigurer ekstraktorer til at læse relevante anmodningsheadere eller felter i indholdet og mappe dem til dokumenterede miljøværdier eller opgaveparametre. Parameterdestinationer skal passe til de prompts, skabelonen accepterer. Hold mappingen præcis: en udgivelsesversion skal blive det tilsigtede input, ikke et ubegrænset kommandofragment. Valider værdien i automatiseringen, når dens betydning kræver det, og test manglende eller uventede felter før produktionsbrug.

Et API-token bruger rettighederne for sin Semaphore-bruger. Brug en identitet, hvis projektadgang svarer til integrationens tilsigtede handlinger, og beskyt tokenet, hvor kalderen gemmer det. API'et omgår ikke projektets autorisation. Konfigurer også den dokumenterede anmodningsautentifikation og eksponering af endpointet bevidst for webhook-integrationer. Hold kalderens autentifikation adskilt fra de legitimationsoplysninger, som den oprettede opgave bruger til infrastrukturen.

Bevar det opgave-ID, den dokumenterede REST-API-operation returnerer, og brug de tilsvarende API-metoder til at undersøge tilstand og output. En vellykket anmodning betyder, at eksekveringen blev bestilt, ikke at infrastrukturopgaven blev fuldført korrekt. Tjenesten bør skelne mellem anmodningsfejl, ventende eller kørende opgaver og afsluttede resultater. Send ingeniører til opgaven, når de skal undersøge de faktiske eksekveringsoplysninger.

Antag ikke garantier for præcis én eksekvering eller varig levering. En ekstern tjeneste kan gentage en anmodning efter timeout, selv om den første nåede Semaphore. Design dublethåndtering og beslutninger om genforsøg efter operationens konsekvenser, og gør den underliggende automatisering idempotent, hvor det er relevant. Bevar sammenhængen mellem den oprindelige hændelse og den kørsel, tjenesten følger, så ingeniører kan forstå gentagne eller usikre leveringer.

Referencen på dette websted viser Swagger/OpenAPI-dokumentet fra Semaphore-udgivelsen, så operationer, stier og skemaer svarer til en bestemt version frem for en håndskrevet opsummering. Gennemse efter ressource på /api-docs/, eller læs rå dokumentation, hvis du genererer en klient. Kontroller altid specifikationen for den anvendte version, da endpoints og anmodningsskemaer kan ændres mellem udgivelser.

Det kaldende system skal kunne nå Semaphore-instansen, men det behøver ikke betyde offentligt internet. Privat netværk, VPN eller intern load balancer er nok, når kalderen kører indenfor. Vores egen matcher- og ekstraktortest brugte en loopback-lytter uden autentifikation, hvilket ikke er en model for et eksponeret endpoint. Konfigurer en understøttet autentifikationsmetode og begræns også netværkseksponeringen, når aliaset kan nås uden for det betroede netværk.

Ret først integrationen mod en ufarlig opgaveskabelon, og send derefter selv data med curl eller en anden HTTP-klient. Send indhold, der ikke matcher, og bekræft, at ingen opgave vises; send derefter matchende indhold, og bekræft, at præcis én opgave starter. Åbn opgavens Details-visning: integrationen registreres som kilde, og udtrukne værdier er synlige for kørslen. Det er samme forløb, vi brugte lokalt, og det fanger en forkert matchernøgle, før en ekstern tjeneste afhænger af den.

Ja. REST-API'et omfatter projekter, repositories, inventarer, legitimation, variabelgrupper, opgaveskabeloner og andre automatiseringsressourcer. Portalen eller infrastrukturtjenesten kan konfigurere dem, starte opgaver og læse eksekveringsstatus og output. Pro viser også workflowkørsler og godkendelser via API'et, så en CI/CD-pipeline kan starte en hel flertrinsoperation. Brug OpenAPI-referencen til endpointparametre og svarskemaer.