Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Beskrivning

<Beskriv vad din applikation/mikrotjänst gör>

Livscykelstatus

<någon av: design, under utveckling, test, produktion, under avveckling, avvecklad>

Lösningsbeskrivning

<Infoga en Gliffy-bild som visuellt beskriver lösningen>SmsSender är en tjänst för att skicka SMS via extern SMS-gateway.

För tillfället finns stöd för två externa SMS-gateways:

  • Telia

  • LinkMobility

Livscykelstatus

Produktion

Lösningsbeskrivning

Gliffy
imageAttachmentIdatt1003028515
baseUrlhttps://sundsvall.atlassian.net/wiki
macroId07594a99-e693-48e5-815f-a57e3660ffea
displayNameSmsSender
nameSmsSender
diagramAttachmentIdatt1003978753
containerId892960781
pagePin1
timestamp1651133420422

Hantering av personuppgifter

<Vilka Inga personuppgifter hanteras och varför?>i tjänsten.

API-specifikation

Expand
titleAPI-nyckel för sandbox-miljö. Klicka på "Authorize" nedan och ange denna nyckel för att testa API:et.

eyJ4NXQiOiJOVGRtWmpNNFpEazNOalkwWXpjNU1tWm1PRGd3TVRFM01XWXdOREU1TVdSbFpEZzROemM0WkE9PSIsImtpZCI6ImdhdGV3YXlfY2VydGlmaWNhdGVfYWxpYXMiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjYXJib24uc3VwZXIiLCJhcHBsaWNhdGlvbiI6eyJvd25lciI6ImFkbWluIiwidGllclF1b3RhVHlwZSI6bnVsbCwidGllciI6IjUwUGVyTWluIiwibmFtZSI6IkNvbmZsdWVuY2UiLCJpZCI6NDksInV1aWQiOiI5MTc3ZGYxZC1hMDQwLTQwMTYtOGVjZC05NGM1OGI1NmFjYTYifSwiaXNzIjoiaHR0cHM6XC9cL2FwaS1pbS10ZXN0LnN1bmRzdmFsbC5zZTo0NDNcL29hdXRoMlwvdG9rZW4iLCJ0aWVySW5mbyI6eyJCcm9uemUiOnsidGllclF1b3RhVHlwZSI6InJlcXVlc3RDb3VudCIsImdyYXBoUUxNYXhDb21wbGV4aXR5IjowLCJncmFwaFFMTWF4RGVwdGgiOjAsInN0b3BPblF1b3RhUmVhY2giOnRydWUsInNwaWtlQXJyZXN0TGltaXQiOjAsInNwaWtlQXJyZXN0VW5pdCI6bnVsbH0sIlVubGltaXRlZCI6eyJ0aWVyUXVvdGFUeXBlIjoicmVxdWVzdENvdW50IiwiZ3JhcGhRTE1heENvbXBsZXhpdHkiOjAsImdyYXBoUUxNYXhEZXB0aCI6MCwic3RvcE9uUXVvdGFSZWFjaCI6dHJ1ZSwic3Bpa2VBcnJlc3RMaW1pdCI6MCwic3Bpa2VBcnJlc3RVbml0IjpudWxsfX0sImtleXR5cGUiOiJTQU5EQk9YIiwicGVybWl0dGVkUmVmZXJlciI6IiIsInN1YnNjcmliZWRBUElzIjpbeyJzdWJzY3JpYmVyVGVuYW50RG9tYWluIjoiY2FyYm9uLnN1cGVyIiwibmFtZSI6IkZlZWRiYWNrU2V0dGluZ3MiLCJjb250ZXh0IjoiXC9mZWVkYmFja3NldHRpbmdzXC8xLjAiLCJwdWJsaXNoZXIiOiJhZG1pbiIsInZlcnNpb24iOiIxLjAiLCJzdWJzY3JpcHRpb25UaWVyIjoiVW5saW1pdGVkIn0seyJzdWJzY3JpYmVyVGVuYW50RG9tYWluIjoiY2FyYm9uLnN1cGVyIiwibmFtZSI6IkFncmVlbWVudCIsImNvbnRleHQiOiJcL2FncmVlbWVudFwvMC4xIiwicHVibGlzaGVyIjoiYWRtaW4iLCJ2ZXJzaW9uIjoiMC4xIiwic3Vic2NyaXB0aW9uVGllciI6IlVubGltaXRlZCJ9LHsic3Vic2NyaWJlclRlbmFudERvbWFpbiI6ImNhcmJvbi5zdXBlciIsIm5hbWUiOiJXZWJNZXNzYWdlU2VuZGVyIiwiY29udGV4dCI6Ilwvd2VibWVzc2FnZXNlbmRlclwvMS4wIiwicHVibGlzaGVyIjoiYWRtaW4iLCJ2ZXJzaW9uIjoiMS4wIiwic3Vic2NyaXB0aW9uVGllciI6IlVubGltaXRlZCJ9LHsic3Vic2NyaWJlclRlbmFudERvbWFpbiI6ImNhcmJvbi5zdXBlciIsIm5hbWUiOiJDYXNlU3RhdHVzIiwiY29udGV4dCI6IlwvY2FzZXN0YXR1c1wvMS4wIiwicHVibGlzaGVyIjoiYWRtaW4iLCJ2ZXJzaW9uIjoiMS4wIiwic3Vic2NyaXB0aW9uVGllciI6IlVubGltaXRlZCJ9LHsic3Vic2NyaWJlclRlbmFudERvbWFpbiI6ImNhcmJvbi5zdXBlciIsIm5hbWUiOiJDYXNlTWFuYWdlbWVudCIsImNvbnRleHQiOiJcL2Nhc2VtYW5hZ2VtZW50XC8zLjIiLCJwdWJsaXNoZXIiOiJhZG1pbiIsInZlcnNpb24iOiIzLjIiLCJzdWJzY3JpcHRpb25UaWVyIjoiVW5saW1pdGVkIn0seyJzdWJzY3JpYmVyVGVuYW50RG9tYWluIjoiY2FyYm9uLnN1cGVyIiwibmFtZSI6IkNhc2VNYW5hZ2VtZW50IiwiY29udGV4dCI6IlwvY2FzZW1hbmFnZW1lbnRcLzMuMyIsInB1Ymxpc2hlciI6ImFkbWluIiwidmVyc2lvbiI6IjMuMyIsInN1YnNjcmlwdGlvblRpZXIiOiJVbmxpbWl0ZWQifSx7InN1YnNjcmliZXJUZW5hbnREb21haW4iOiJjYXJib24uc3VwZXIiLCJuYW1lIjoiQnVzaW5lc3NFbmdhZ2VtZW50c19zYW5kYm94IiwiY29udGV4dCI6IlwvYnVzaW5lc3NlbmdhZ2VtZW50c1wvc2FuZGJveFwvMS4wIiwicHVibGlzaGVyIjoiYWRtaW4iLCJ2ZXJzaW9uIjoiMS4wIiwic3Vic2NyaXB0aW9uVGllciI6IkJyb256ZSJ9LHsic3Vic2NyaWJlclRlbmFudERvbWFpbiI6ImNhcmJvbi5zdXBlciIsIm5hbWUiOiJCdXNpbmVzc0VuZ2FnZW1lbnRzIiwiY29udGV4dCI6IlwvYnVzaW5lc3NlbmdhZ2VtZW50c1wvMS4wIiwicHVibGlzaGVyIjoiYWRtaW4iLCJ2ZXJzaW9uIjoiMS4wIiwic3Vic2NyaXB0aW9uVGllciI6IkJyb256ZSJ9LHsic3Vic2NyaWJlclRlbmFudERvbWFpbiI6ImNhcmJvbi5zdXBlciIsIm5hbWUiOiJGZWVkYmFja1NldHRpbmdzIiwiY29udGV4dCI6IlwvZmVlZGJhY2tzZXR0aW5nc1wvMS4xIiwicHVibGlzaGVyIjoiYWRtaW4iLCJ2ZXJzaW9uIjoiMS4xIiwic3Vic2NyaXB0aW9uVGllciI6IlVubGltaXRlZCJ9LHsic3Vic2NyaWJlclRlbmFudERvbWFpbiI6ImNhcmJvbi5zdXBlciIsIm5hbWUiOiJEaXN0dXJiYW5jZXMiLCJjb250ZXh0IjoiXC9kaXN0dXJiYW5jZXNcLzIuMCIsInB1Ymxpc2hlciI6ImFkbWluIiwidmVyc2lvbiI6IjIuMCIsInN1YnNjcmlwdGlvblRpZXIiOiJVbmxpbWl0ZWQifSx7InN1YnNjcmliZXJUZW5hbnREb21haW4iOiJjYXJib24uc3VwZXIiLCJuYW1lIjoiQXJjaGl2ZSIsImNvbnRleHQiOiJcL2FyY2hpdmVcLzAuMSIsInB1Ymxpc2hlciI6ImFkbWluIiwidmVyc2lvbiI6IjAuMSIsInN1YnNjcmlwdGlvblRpZXIiOiJVbmxpbWl0ZWQifSx7InN1YnNjcmliZXJUZW5hbnREb21haW4iOiJjYXJib24uc3VwZXIiLCJuYW1lIjoiRmVlZGJhY2tTZXR0aW5ncyIsImNvbnRleHQiOiJcL2ZlZWRiYWNrc2V0dGluZ3NcLzIuMCIsInB1Ymxpc2hlciI6ImFkbWluIiwidmVyc2lvbiI6IjIuMCIsInN1YnNjcmlwdGlvblRpZXIiOiJVbmxpbWl0ZWQifSx7InN1YnNjcmliZXJUZW5hbnREb21haW4iOiJjYXJib24uc3VwZXIiLCJuYW1lIjoiRW1haWxTZW5kZXIiLCJjb250ZXh0IjoiXC9lbWFpbC1zZW5kZXJcLzEuMCIsInB1Ymxpc2hlciI6ImFkbWluIiwidmVyc2lvbiI6IjEuMCIsInN1YnNjcmlwdGlvblRpZXIiOiJVbmxpbWl0ZWQifSx7InN1YnNjcmliZXJUZW5hbnREb21haW4iOiJjYXJib24uc3VwZXIiLCJuYW1lIjoiU21zU2VuZGVyIiwiY29udGV4dCI6Ilwvc21zLXNlbmRlclwvMS4wIiwicHVibGlzaGVyIjoiYWRtaW4iLCJ2ZXJzaW9uIjoiMS4wIiwic3Vic2NyaXB0aW9uVGllciI6IlVubGltaXRlZCJ9XSwicGVybWl0dGVkSVAiOiIiLCJpYXQiOjE2NDgwNDEwNjIsImp0aSI6IjNlZjY3ZjU1LTk5NmEtNDY3MC1hMDYwLWViYzgzMTYzYTJlMiJ9.rtuJwy7c2zLFsUIc8cA-xfrjHWpbO0trqUc_MGPpHJLKO4-lulNKIRc5bfL8hWyOLW7Yc-idmtZyi4buR6xbMIfx6Nnp_VG3xFo-DamINhfQgJdKdIjqq4u7M9xoUAB3qx0qHUHSw7B8lih30hv79Kxjo4OO9dhHRg3Sljqjd2AtrLPG6rT7j1tiSz7wyxfVXJXhlZ5NgvnKLxvFdpOgiBUQ9GtbFwMrYby3_D-yzhTB9lrLRsjJ0PoPYdn5FM3St0KolFiw4QP2RetFHz5XgPXhK3SSlqSa4jfL6aYOjHC8tJZAcqCPG2TTHM0X5ITBVDN3vemnDDYBZBooCSrjvw==

openapi: 3.0.1 info: title: SmsSender contact: {} license: name: MIT License url: https://opensource.org/licenses/MIT version: "1.0" servers: - url: / paths: /send/sms: post: tags: - Sms Resources summary: Send an SMS operationId: sendSms requestBody: content: application/json: schema: $ref: '#/components/schemas/SmsRequest' required: true responses: "400": description: Bad Request content: '*/*': schema: $ref: '#/componentsschemas/Problem' "500": description: Internal Server Error content: '*/*': schema: $ref: '#/components/schemas/Problem' "200": description: Successful Operation content: '*/*': schema: type: boolean /: get: tags: - API summary: OpenAPI operationId: getApiDocs responses: "200": description: OK content: application/yaml: schema: type: string x-auth-type: None x-throttling-tier: Unlimited x-wso2-mutual-ssl: Optional security: - ApiKeyAuth: [] components: schemas: SmsRequest: required: - message - mobileNumber - sender type: object properties: sender: maxLength: 11 minLength: 0 type: string description: The Sender of the SMS example: sender mobileNumber: pattern: "^\\+467[02369]\\d{7}$" type: string description: Mobile number should start with +467x message: type: string Problem: type: object properties: instance: type: string format: uri type: type: string format: uri parameters: type: object additionalProperties: type: object status: $ref: '#/components/schemas/StatusType' title: type: string detail: type: string StatusType: type: object properties: statusCode: type: integer format: int32 reasonPhrase: type: string securitySchemes: ApiKeyAuth: type: apiKey in: header name: apikey
Swagger ui
Open api
showCommonExtensionstrue
deepLinkingtrue
supportedSubmitMethodsnone
locationurl
showExtensionstrue
urlhttps://api-test.sundsvall.se/sms-sender
/
api-docs


Säkerhetsklassning

Säkerhetsklass 1

Autentiseringsmetod: Oauth2

(Ref: Säkerhetsklassning av APIer )

API-ägare

<Kontaktuppgifter till den verksamhet som äger APIets livscykel>

Teknisk ägare

https://sundsvall.atlassian.net/wiki/spaces/API

Ansvarigt team: Team Dynasty
För tekniska frågor: teamdynasty@sundsvall.se

Länkar

FAQ

<FAQ>

Källkod

https://github.com/OpenSundsvall/api-service-sms-sender

FAQ