Stadsnätsportalen: SP ON-API 2.5

SP ON-API 2.5

All API's Endpoints

API documentation

SP ON-API

products

API where the Service Provider is the origin of data and the Communication Operator is the consumer

FormatJSON AuthHTTP Auth OriginService Provider ConsumerCommunication Operator

products

This API lists product offerings that are available to end customers and information about the service provider.

The definition of product offerings include campaigns as well as standard offerings.

Allows the CO to periodically list all product offerings from SPs for publishing in portals
Allows the CO to request product offerings on a specific access on-demand to ensure availability on that access

Request

GET /plain/onapi/[spId]/products
Content-Type: application/json
- Response success: 200 OK
  
  HTTP/1.1 200 OK
  Content-Type: application/json
  { "serviceProvider": { "phone": "013-212121", "openingHours": "07:00-16:00", "email": "acmeab@example.com", "website": "https://acmeab.example.com", "presentation": "Acme AB är en rikstäckande leverantör av höghastighetsinternet", "files": [ { "type": "TermsAndConditions", "url": "http://example.com/allmannavilkor.pdf", "updated": "2007-04-05T14:30Z" }, { "type": "PrivacyPolicy", "url": "http://example.com/integritetspolicy.pdf", "updated": "2007-04-05T14:30Z" }, { "type": "Logo", "url": "http://example.com/logo_small.jpg", "updated": "2007-04-05T14:30Z" } ] }, "products": [ { "coProducts": [ "100/100" ], "productId": "1f94f25b-3ae0-434f-a49e-bc4d3093e399", "marketingInformation": { "productName": "Bredband 100/100", "categories": [ "internet" ], "description": "Bra snabbt Internet" }, "files": [ { "type": "TermsAndConditions", "url": "http://example.com/sarskildavilkor.pdf", "updated": "2007-04-05T14:30Z" }, { "type": "Logo", "url": "http://example.com/logo_small.jpg", "updated": "2007-04-05T14:30Z" } ], "offerings": [ { "offeringId": "821cfc90-762a-4272-aacf-ba7ffed8614c", "marketingInformation": { "offeringName": "Utan bindningstid", "consumerTypes": [ "residential", "business" ], "description": "Bra snabbt Internet utan bindingstid", "deliveryInformation": "Vi kontaktar dig om installation av CPE krävs", "startPrice": "0", "price": "250", "pricePeriod": "P1M", "periodOfNotice": "P1M", "agreementLength": "P1M" } }, { "offeringId": "bf134676-0830-4d61-8af0-94f00a0270da", "marketingInformation": { "offeringName": "Halva priset 3 månader", "consumerTypes": [ "residential", "business" ], "description": "Första tre månaderna gratis, 12 månaders bindningstid", "startPrice": "0", "price": "125", "pricePeriod": "P1M", "periodOfNotice": "P1M", "agreementLength": "P1Y", "campaignLength": "P3M", "basePrice": "250", "campaignCodes": [ "billig", "hemlig" ], "campaign": true } }, { "productsId": "c9c47535-ffa9-4456-9706-9ef590e1ce48", "marketingInformation": { "name": "Inklusive wifi-router", "consumerTypes": [ "residential" ], "description": "Få en exklusiv router med abonnemanget för endast 25 kr mer i månaden, 3 månaders bindningstid", "startPrice": "0", "price": "275", "pricePeriod": "P1M", "periodOfNotice": "P1M", "agreementLength": "P3M", "valueAdded": "950" } } ] } ] }
  - Definitions
    serviceProvider
    
    Object describing the service provider. The intended purpose is to allow portals to present the service provider and show contact details
    
    mandatory serviceProvider.email
    
    mandatory
    Data format: string
    Example: sales@provider.com
    Email address to sales or customer service
    
    optional serviceProvider.openingHours
    
    optional
    Data format: string
    Example: Mon-Fri 07:30-17:00, Sat-Sun 11:00-15:00
    Times should be presented in the format HH:mm, e.g. "07:30", and the opening hours of a day include both a start and an end time separated by '-' as in "07:30-17:00"
    
    Optionally, opening hours can include the day of week, or indicate a span, e.g. "Monday 07:30-17:00" or "Monday-Friday 07:30-17:00".
    
    Opening hours on different days of the week should be separated by ','.
    
    Special opening hours on weekends can be specified surrounded by parentheses, unless the day of the week is stated specifically, e.g. "07:30-17:00 (10:00-15:00)"
    
    mandatory serviceProvider.phone
    
    mandatory
    Data format: string
    Example: 08-132 456 78
    Phone number to sales or customer service
    
    mandatory serviceProvider.presentation
    
    mandatory
    Data format: string
    Short presentation of the service provider
    
    mandatory serviceProvider.website
    
    mandatory
    Data format: string
    Example: https://www.example.com
    Web address to service provider homepage
accessId

GET /plain/onapi/[spId]/products/[accessId]
Content-Type: application/json
List offerings for accessId

Lists offerings on the specific access. When this endpoint is used, the CO has already performed a feasibility check and added the result in the request. Given an array of CO transmission products, the service provider responds with a list of offerings available on the specific access. The "coProduct" is the same field as services/service specified in the CO endpoint accesses API

POST /plain/onapi/[spId]/products/[accessId]
Content-Type: application/json
{ "coProducts": [ "10/10", "100/10", "100/100", "250/100", "250/250", "500/100", "500/500", "1000/100", "1000/1000" ] }

SP ON-API 2.5

Response success: 200 OK

Definitions

serviceProvider

mandatory serviceProvider.email

optional serviceProvider.openingHours

mandatory serviceProvider.phone

mandatory serviceProvider.presentation

mandatory serviceProvider.website