DesignElements API versjon 2

Dette er dokumentasjon for Amedias designElements versjon 2. DesignElements er ment for bruk dersom man ønsker å bruke avisens meny og bunn for andre sider, enten utviklet av avisen selv eller andre.

Adresser

Elementene er tilgjengelige på flere forskjellige adresser, basert på forskjellige miljøer: produksjon, test og staging.

  • Produksjon: http://services.api.no/api/designelements/v2/manifests
  • Staging: http://services.v3stage.api.no/api/designelements/v2/manifests
  • Test: http://services.test.api.no/api/designelements/v2/manifests

Autentisering

For å bruke design elements trenger du en api-key. For å få en api-key, kontakt oss.

Eksempel på autentisering

curl -H "apikey: TOKEN" "https://services.api.no/api/designelements/v2/manifests?elements=header,footer&domain=www.ba.no"

TOKEN er nøkkelen du får fra Amedia Utvikling.

API

API-kallene ligger under følgende stier (som legges til tjenesteadressene over)

Element-manifest

/manifest/{element}

Denne tjenesten gir svarer med en manifest-fil på JSON-format som beskriver hvilke presentasjonsressurser (css og/eller javascript) elementet trenger for å fungere som tenkt, og link til hvor innholdet fra elementet kan hentes (URI). Ansvaret for å laste disse ressursene inn i sider som skal bruke elementene, ligger på den som bruker elementet. Det er ikke tilrådelig å hente manifestet en gang og bruke ressursene hardkodet. Det anbefales sterkt å hente manifest og skrive inn linker i html-siden når siden skal presenteres for sluttbrukeren.

Parametere:

  • domain=www.avisnavn.no vil gi manifestinnhold uten placeholdere, men med avisens navn inkludert i stier til ressurser.
  • inline=true vil gi elementets innhold (html) som et felt i manifestet, i tillegg til metadata om elementet.

Eksempel:

https://services.api.no/api/designelements/v2/manifest/header?domain=www.avisnavn.no

{
  "resources": [
    {
      "uri": "//r.acdn.no/api/maelstrom/v1/css/publication/www.avisnavn.no/publication.css",
      "type": "text/css"
    },
    {
      "uri": "//bed.api.no/api/curiosity/v1/css/searchbox.css",
      "type": "text/css"
    }
  ],
  "contentUri": "http://services.api.no/api/designelements/v2/header?domain=www.avisnavn.no",
  "content": ""
}

(dersom inline=true er spesifisert, vil html for elementet ligge i content-feltet.)

Multi-manifest

/manifests?elements={element1},{element2}

Multimanifest-tjenesten gir samme datastruktur som over, men vil gi en JSON-array med et element for hvert element som er forespurt. Inlining av elementets innhold er alltid på for multi-element kall, og derfor er også domain-parameter (se over) påkrevd for at tjenesten kan lage elementet for en spesifikk avis.

Parametere:

  • domain=www.avisnavn.no er påkrevd for å gi elementet for den gitte avisen.
  • elements=www.avis1no,www.avis2.no

Eksempel:

https://services.api.no/api/designelements/v2/manifests?elements=header&domain=www.rb.no

Element-innhold

/{element}

Tjenesten returnerer html markup (og kun det) for et element. Som nevnt over, er det den som kaller elementet som må besørge at ressursene som er listet opp i manifestet lastes sammen med siden.

Parametere:

  • domain=www.avisnavn.no er påkrevd for å gi elementet for den gitte avisen.

Eksempel:

https://services.api.no/api/designelements/v2/header?domain=www.rb.no

(Alle ord i klammer i adressene over, byttes ut med reelle element-navn ved bruk.)

Elementer

Elementet “footer” sidebunnen som brukes på alle avissider i dag.

Elementet “footer” headeren som brukes på alle avissider i dag.

minimal_header

Enkel versjon av headeren med kun logo og bakgrunnsfarge.

Elementet returnerer en url til logo for avisen.

Statistikk - tellekoder

Gå hit for å hente loggekoder til DAX: http://merinnsikt.no/inlinetag/