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 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Hantering av personuppgifter
<Vilka Inga personuppgifter hanteras och varför?>i tjänsten.
API-specifikation
Expand | ||
---|---|---|
| ||
|
Swagger ui | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Open api | ||||||||||||||||||
| /
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: '#/components
| schemas/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
||||||||||||||||
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
Sandbox - TBD
FAQ
<FAQ>Källkod
https://github.com/OpenSundsvall/api-service-sms-sender