This is in beta. If you find something wrong, let us know

Digital Capability Locator Service

Getting Started

Errata

Core Discovery API

Management API - Mandatory Services

Management API - Optional Services

Additional API's

Additional API's

These API's are not documented in the DCL Implementation Guide and are offered to improve the functionality of the DCL.

Generic search API

GET
Accept: [application/json | application/xml]
/serviceProviders
/serviceProviders?limit=50&offset=0
/serviceProviders?limit=50&offset=0&type=[DCP | AP]
/serviceProviders?limit=50&offset=0&Legalid={business-identifier}

Example URL:

https://uatapi.intechdcl.com/api/v1/serviceProviders?offset=0&limit=2

Example response (JSON):

{
  "metadata":  {
    "resultset":  {
      "count": 37,
      "offset": 0,
      "limit": 50
    }
  },
  "results": [
    {
      "ServiceProviderID": "428",
      "legalId": "83052118",
      "name": "Daniel Testing Provider",
      "accreditationStatus": "Active",
      "contactEmail": "apiupdate@intecdcl.com",
      "URL": "https://DCP428.DI.com.au",
      "ClientCertificates": [
        "LS0tLS1CRUdJTiBDRVJUSUZJQ0...",
        ""
      ],
      "ServerCertificates": [
        "",
        ""
      ]
    },
    {
      "ServiceProviderID": "429",
      "legalId": "67093253304",
      ...

Example response (XML):

<?xml version="1.0" encoding="UTF-8"?>
<AccreditedProviders>
    <Metadata>
        <ResultSet>
            <Count>37</Count>
            <Offset>0</Offset>
            <Limit>50</Limit>
        </ResultSet>
    </Metadata>
    <Results>
        <Provider>
            <ServiceProviderID>428</ServiceProviderID>
            <LegalId>83052118</LegalId>
            <Name>Daniel Testing Provider</Name>
            <AccreditationStatus>Active</AccreditationStatus>
            <ContactEmail>apiupdate@intecdcl.com</ContactEmail>
            <URL>https://DCP428.DI.com.au</URL>
            <ClientCertificates>
                <ClientCertificate>LS0tLS1CRUdJTiBDRVJUSUZJQ0...</ClientCertificate>
                <ClientCertificate></ClientCertificate>
            </ClientCertificates>
            <ServerCertificates>
                <ServerCertificate></ServerCertificate>
                <ServerCertificate></ServerCertificate>
            </ServerCertificates>
        </Provider>
        <Provider>
            <ServiceProviderID>429</ServiceProviderID>
            <LegalId>67093253304</LegalId>
            ...

Update Digital Capability Publisher details

The DCP update service also allows a client to update other DCP details, notably:

PUT
Content-Type: [application/json | application/xml]
Accept: [application/json | application/xml]
/capabilityPublishers/{capability-publisher-id}

Example request body (JSON)

{
	"capabilityPublisherID": "443",
	"ClientCertificates": "LS0tLS1CRUdJTiBDRVJUSUZJQK...",
	"ClientCertificateStatus": "Active",
	"ServerCertificates": "0TzROVzc1TVlFS2JUa004Q0Jl...",
	"ServerCertificateStatus": "Active",
	"URL": "https://mynewdcp.com",
	"contactEmail": "info@mynewdcp.com"
}

Example request body (XML)

<?xml version="1.0" encoding="utf-8"?>
<UpdateCapabilityPublisherEndpoint>
  <CapabilityPublisherID>443</CapabilityPublisherID>
	<ClientCertificates>LS0tLS1CRUdJTiBDRVJUSUZJQK...</ClientCertificates>
	<ClientCertificateStatus>Active</ClientCertificateStatus>
	<ServerCertificates>0TzROVzc1TVlFS2JUa004Q0Jl...</ServerCertificates>
	<ServerCertificateStatus>Active</ServerCertificateStatus>
	<URL>https://mynewdcp.com</URL>
	<contactEmail>info@mynewdcp.com</contactEmail>
</UpdateCapabilityPublisherEndpoint>

Update Access Point details

Access point details can be changed using this service. The attributes that can be changed are: The DCP update service also allows a client to update other DCP details, notably:

PUT
Content-Type: [application/json | application/xml]
Accept: [application/json | application/xml]
/accesspoints/{access-point-id}

Example request body (JSON):

{
	"accessPointID": "442",
	"ClientCertificates": "VElGSUNBVEUtLS0tLQpNS...",
	"ClientCertificateStatus": "Active",
	"ServerCertificates": "T0JCWUVGSnV2cWxtZ2ZyNGdT...",
	"ServerCertificateStatus": "Active",
	"URL": "https://mynewap.com",
	"contactEmail": "info@mynewap.com"
}

Example request body (XML)

<?xml version="1.0" encoding="utf-8"?>
<UpdateAccessPointEndpoint>
  <AccessPointID>442</AccessPointID>
	<ClientCertificates>VElGSUNBVEUtLS0tLQpNS...</ClientCertificates>
	<ClientCertificateStatus>Active</ClientCertificateStatus>
	<ServerCertificates>T0JCWUVGSnV2cWxtZ2ZyNGdT...</ServerCertificates>
	<ServerCertificateStatus>Active</ServerCertificateStatus>
	<URL>hhttps://mynewap.com</URL>
	<contactEmail>info@mynewap.com</contactEmail>
</UpdateAccessPointEndpoint>

Who am I

Included in the set of DCL API's is a convenience API to retrieve the details of a service provider. Some API requests require the service ID of the service related to the certificate that is used for authentication. The API below can be used to retrieve this ID.

GET
Accept: [application/json, application/xml]
/WhoAmI

Example request:

curl --key ap_key.pem --cert ap_cert.pem https://uatapi.intechdcl.com/api/v1/whoami

Example response (JSON):

{
    "ServiceID": "442",
    "AccessPointID": "442",
    "ServiceStatus": "Active",
    "Fingerprint": "7c:90:46:27:1f:e5:e1:e8:1f:d7:13:b3:9b:e0:a1:86:11:e8:96:34",
    "Serial": "bd:09:0c:72:45:6d:1a:07:fe:b0:94:1e:0d:4a:48:e5",
    "Subject": "Access Point",
    "Issuer": "Digital Capability Locator Authority;",
    "NotBefore": "2018-03-27 01:39:08 GMT",
    "NotAfter": "2019-09-08 01:11:37 GMT"
}

Example response (XML):

<?xml version="1.0" encoding="UTF-8"?>
<DCL-WhoAmI>
    <ServiceID>442</ServiceID>
    <DigitalCapabilityPublisherID>442</DigitalCapabilityPublisherID>
    <ServiceStatus>Active</ServiceStatus>
    <Fingerprint>7f:9b:59:b8:9d:01:95:14:9f:56:bc:5e:88:a0:dd:c8:06:f5:94:19</Fingerprint>
    <Serial>be:7b:65:b4:a2:59:25:0e:b9:bb:a7:24:c2:0f:02:e2</Serial>
    <Subject>Access Point</Subject>
    <Issuer>Digital Capability Locator Authority;</Issuer>
    <NotBefore>2018-03-27 02:50:43 GMT</NotBefore>
    <NotAfter>2019-09-08 01:11:37 GMT</NotAfter>
</DCL-WhoAmI>


Last edited: 12 Nov 2018, 11:01:44