api

Atlas API

API Endpoint: Atlas API
API för att komma åt modulerna i Atlas. API:et använder samma rättigheter som webbgränssnittet, så API-användaren måste ha rättighet att komma åt modulen
Endpoint URL http://www.example.com/admin/api/plain/atlas
This API does not require granted privileges, and is open to any user API key This API does not require granted privileges, and is open to any user API key
  • Method: list_posts

  • Den här funktionen listar poster i databasen för den angivna modulen. Svaret innehåller de fält som finns i databasen för modulen.
  • Parameters
    1 hash string green xxxxx The API hash from api_login()
    2 module string green faq The name of the module you want to list
    3 start int green 1 From which post do you want to start listing?
    4 show int green 20 How many posts do you want to show?
    Endpoint example:
    https://www.example.com/admin/api/plain/atlas?method=list_posts&hash=xxxxx&module=faq&start=1&show=20
  • success response


       <list_posts>
          <response>
             <post>
                <headline>Headline of post</headline>
                <category>Category of post</category>
                <text>Text of post</text>
             </post>
          </response>
          <status>success</status>
       </list_posts>
  • Method: save_post

  • Funktion för att spara en post i systemet. Om du vill uppdatera en befintlig post så ska data-arrayen innehålla id-numret för en befintlig post.

    Data-arrayen anges enligt PHP-standard, det till säga att för att spara en post i modulen "faq" med en rubrik satt till "test" och kategori "Fråga" så ska anropet se ut så här:

    /admin/api/plain/atlas?hash=XXXX&method=save_post&module=faq&data[headline]=Test&data[category]=Fr%E5ga
    Om posten sparas korrekt så innehåller svaret ID-numret på den sparade eller uppdaterade posten.
  • Parameters
    1 hash string green xxxxx The API hash from api_login()
    2 module string green faq The name of the module you want to save a post to
    3 data array green [array] Array of data correlating to the fields of the module
    Endpoint example:
    https://www.example.com/admin/api/plain/atlas?method=save_post&hash=xxxxx&module=faq&data=%5Barray%5D
  • success response


       <save_post>
          <response>705079</response>
          <status>success</status>
       </save_post>