authentication issue with web API

Hi Vidhu,

In order to use a Web API, follow the steps.

Create one Service Account user

Add the Service Account user to the Service Account group

Go to the Admin console, under API Keys create one API key and mention the Service Account User

Once you create you will get the API key and save it first.

Create Web API access group, add the Service Account user in that group

Create Web API

Add security for the Web API by making  Web API access group as viewers

Create a connected system with API key Authentication by providing header Appian-API-Key or as mentioned in community

Call the integration as a rule by passing the required parameters if any.

In old versions.

You have to create a user with the same basic authentication username and password

You need to create the secure credential store with the same basic authentication username and password

You have to add the user to the Web API Access group (Any group that has to access the Web API)

You have to make Web API Access group as a viewer to the web api and the application.

Hi , Thanks for the response. I followed the steps, and request you to provide some additional guidance.

Create one Service Account user

Add the Service Account user to the Service Account group

Go to the Admin console, under API Keys create one API key and mention the Service Account User

Once you create you will get the API key and save it first.

Create Web API access group, add the Service Account user in that group

Create Web API

Add security for the Web API by making  Web API access group as viewers

Create a connected system with API key Authentication by providing header Appian-API-Key or as mentioned in community

[Vidhu] : Completed the steps mentioned above successfully

Call the integration as a rule by passing the required parameters if any.

[Vidhu] : you please elaborate this one. Where in API I would enter/pass my API Key.??

Vidhu

Inside the integration designer, under Headers section click on Add Header link. Type Appian-API-Key as a name and paste the API key under value. For further details you can find in this link community

I actually don't think creating a connected system / integration is necessary. This would only be necessary if you wanted to do a circular reference - essentially have Appian call itself for testing purposes.

Since you mentioned that you plan on calling the Web API from an external system, I'd recommend testing it externally too since that will be a better test of how your Web API should be used. There are a bunch of external tools you can use that call rest APIs (for example, I like SOAP UI). You can set up a tool like that to point to your web API and provide the API key credentials. See the Web API documentation for the different methods of adding your credentials to the request: https://docs.appian.com/suite/help/latest/Web_API_Authentication.html#using-api-keys

Thanks Dudeand Peter Lewis for suggestions.

I was finally able to get the data via SOAP UI. I now have a user which I have assigned to my API but as soon as I put that user in Service Accounts groups, I stop getting data and API starts to fail with Authentication failed error. Any suggestion how can I resolve this ? The user I have created is a Basic user which has access to webAPI hence it is working but I am able to login in my application using that user as well (which I dont want).

Hi Vidhu,

Can you make the service account user as system administrator instead of basic user and try?

I tried that too, did not work.

I tried that too, did not work.

Any other suggestions from anyone ?

Please check the security for web api and Datastore objects whether that user has proper access.