Profile picture for user fengelbert
This video introduces the ARIS Restful API and shows several example API calls as well as an example external web application that interacts with ARIS. Content:
  1. ARIS Connect Repository API (ARIS 10 SR 11)
  2. Web Application that makes several calls to ARIS Connect (POST tokens, GET list of databases, GET find items in database, GET png graphic of model by id, PUT update a model)

 

by Charlie Emple
Posted on Thu, 01/21/2021 - 15:07

I was hoping to use my free trial to gain access to your API documentation, but I am getting 403 Forbidden when I attempt to add apidocs to the server URL... I created the trial and am listed as having Admin priviledge. Is there a way to gain access to the API documentation within the free trial?

0
by Michał Kleszczewski
Posted on Mon, 08/09/2021 - 15:15

Hi,

is it available some test environment for the API or I have to have the Enterpise version?

Best regards,

Michał

0
by Runé Becker
Badge for 'Mastermind' achievement
Posted on Tue, 08/10/2021 - 18:21

In reply to by mkleszczewski

Dear Michael,

We don't have an official test environment for ARIS RESTful API as that functionality is available in every ARIS installation. And when you open ARIS_10.0_SR13_Mobile_Access_Legal_Terms.pdf  on the ARIS Mobile/API Access certification inquiry form you can check which ARIS client license includes which ARIS API license.

On your ARIS Server you can access ARIS PI via by adding /apidocs in the URL instead of /#default/home.

Cheers
Rune

0
by Imran Usman Khatyan
Posted on Wed, 08/25/2021 - 12:59

Hello, 

Is there ARIS API Documentation available anywhere? and can i access it without enterprise?

0
by Veronika Ellermann
Posted on Wed, 08/25/2021 - 15:50

In reply to by iusman

Hi Imran,

Yes there is (however, I am not sure what you mean with "without enterprise"), you can find it under: 

[Your ARIS URL]/apidocs/

e.g.: https://aris.example.loc/apidocs/

Hope this helps. 

Best,

Veronika

0
by Eduardo Cuauhtémoc Alva Ramírez
Posted on Thu, 05/12/2022 - 18:40

Hi, I have contacted software AG to ask them for a key to use the Restful API and they gave me one, then I have tried to get a token in the login api with my username and then with the master account and it returns me a 403 error. Do you know what I have to do?

0
by Jens Heylmann
Posted on Fri, 05/13/2022 - 08:34

Example how to create a token

mobileAPIKey will be you license key

 

function getToken() {
    return new Promise(function (resolve, reject) {
        var settings = {
            "url": host + "umc/api/tokens",
            "method": "POST",
            "headers": {
                "content-type": "application/x-www-form-urlencoded"
            },
            "data": {
                "tenant": "default",
                "name": "system",
                "password": "abc",
                "key": mobileAPIKey
            }
        };
        $.ajax(settings).done(function (response) {
            resolve(response.token);
        });
    });
}

 

0
by Francois Du Toit
Posted on Thu, 06/16/2022 - 16:03

ARIS is one of the only systems I know of that not only charges for its API but is also not generally available to its users.

A shame really...

0

Featured achievement

Rookie
Say hello to the ARIS Community! Personalize your community experience by following forums or tags, liking a post or uploading a profile picture.
Recent Unlocks

Leaderboard

|
icon-arrow-down icon-arrow-cerulean-left icon-arrow-cerulean-right icon-arrow-down icon-arrow-left icon-arrow-right icon-arrow icon-back icon-close icon-comments icon-correct-answer icon-tick icon-download icon-facebook icon-flag icon-google-plus icon-hamburger icon-in icon-info icon-instagram icon-login-true icon-login icon-mail-notification icon-mail icon-mortarboard icon-newsletter icon-notification icon-pinterest icon-plus icon-rss icon-search icon-share icon-shield icon-snapchat icon-star icon-tutorials icon-twitter icon-universities icon-videos icon-views icon-whatsapp icon-xing icon-youtube icon-jobs icon-heart icon-heart2 aris-express bpm-glossary help-intro help-design Process_Mining_Icon help-publishing help-administration help-dashboarding help-archive help-risk icon-knowledge icon-question icon-events icon-message icon-more icon-pencil forum-icon icon-lock