Stadsnätsportalen: Atlas API

Den här sidan använder cookies för vissa funktioner: Jag förstår Mer information

Atlas API

Methods

activate
deactivate
service_uid
services

API Endpoint: Admin

API för att aktivera, avaktivera och sätta service_uid i Tjänsteguiden, riktat för integration mot tjänsteplattform

Endpoint URL https://www.example.com/admin/edit/services/plain/adminapi

Note that this API requires authenticated user id and IP address and a hashed api credential

Method: activate
Request Parameters

1 hash string ABC123 hash from api_login

2 id int 1234 Id of service to activate, from method services()

Endpoint example:
GET: https://www.example.com/admin/edit/services/plain/adminapi?method=activate&hash=ABC123&id=1234
Method: deactivate
Request Parameters

1 hash string ABC123 hash from api_login

2 id int 1234 Id of service to deactivate, from method services()

Endpoint example:
GET: https://www.example.com/admin/edit/services/plain/adminapi?method=deactivate&hash=ABC123&id=1234
Method: service_uid
Request Parameters

1 hash string ABC123 hash from api_login

2 id int 1234 ID of service from method services()

3 uid string PRIVATE1010 New service_uid for service

Endpoint example:
GET: https://www.example.com/admin/edit/services/plain/adminapi?method=service_uid&hash=ABC123&id=1234&uid=PRIVATE1010
Method: services
Request Parameters

1 hash string ABC123 hash from api_login

2 target string consumers What target to list services from ('consumers', 'companies', 'seniors', 'students', 'property')

Endpoint example:
GET: https://www.example.com/admin/edit/services/plain/adminapi?method=services&hash=ABC123&target=consumers

success response

   <services>
      <response>
         <service>
            <id>18224</id>
            <name>10/10 Mbit/s + Telefoni Standard</name>
            <category>Internet, Via fiber, Telefoni, Telefoni Standard</category>
            <service_uid>BAHNHOF1010PRIVAT</service_uid>
            <xsp>Bahnhof</xsp>
            <speedup>10000</speedup>
            <speeddown>10000</speeddown>
            <status>active</status>
            <validation>ok</validation>
         </service>
         <service>
            <id>18225</id>
            <name>100/10 Mbit/s + Telefoni Standard</name>
            <category>Internet, Via fiber, Telefoni, Telefoni Standard</category>
            <service_uid>

            </service_uid>
            <xsp>Bahnhof</xsp>
            <speedup>10000</speedup>
            <speeddown>100000</speeddown>
            <status>active</status>
            <validation>ok</validation>
         </service>
      </response>
      <status>success</status>
   </services>

1	hash	string		ABC123	hash from api_login
2	id	int		1234	Id of service to activate, from method services()

1	hash	string		ABC123	hash from api_login
2	target	string		consumers	What target to list services from ('consumers', 'companies', 'seniors', 'students', 'property')

Atlas API

Method: activate

Method: deactivate

Method: service_uid

Method: services