API integration

[AakashPatel]

I need to start on API automation. What are key thing i should be taking into consideration and asking the detial with team on API.

------------------------------
Aakash Patel
------------------------------

[BernardTheroux]

Hello,

I interact with BMC Remedy . NET Api in some project I built.

In my experience with the API all the dll  need to be install in the Blue Prism installation server. 

Personnally I put all the coding in a DLL I made. Easier to debug, Then I simply pass the function with the proper vaiables. 

Blue Prism is not user freindly in the coding mode. 

For sure, the same Dll as too be install on all the bots that will do the automation. 

Itall it works fine for me.

------------------------------
Bernard Theroux
Blue Prism Certified Developper
Bell Canada
Montréal, Qc, Canada
------------------------------

[ewilson]

Hi @AakashPatel2,

@BernardTheroux has a good point. Whenever I Need to do anything significant in code I tend to build out the code in Visual Studio and then copy the final code into my Code stage in Blue Prism. Alternatively, if you have a lot of code, building that into your own .NET assembly DLL and then just calling the exposed methods from your Blue Prism Code stage is a good option too.

If you do run into issues within a Code stage, you can do some basic debugging by including a reference to the System.Windows.Forms.dll and then you can make use of the .NET MessageBox object to pop up dialogs letting you know how you code is progressing. Another option would be to make use of NLog if you want to write out your own log files.

Cheers,
​​

------------------------------
Eric Wilson
Director, Integrations and Enablement
Blue Prism Digital Exchange
------------------------------

[CharlesReily]

When embarking on API automation, it's crucial to gather comprehensive information from your team. Start by asking about the level of access required for different endpoints. Are there distinct user roles within the system, and how does access vary based on these roles? Understanding the permission structure ensures that your API automation strategy aligns with the diverse user requirements and security protocols. Additionally, inquire about the authentication methods employed for business information API endpoints. Knowing whether the system utilizes API keys, OAuth tokens, or other authentication mechanisms is vital for creating secure and effective automation scripts. Clarify the expected data formats for both request payloads and response bodies. Confirm whether the APIs support JSON, XML, or other formats, as this knowledge is essential for crafting accurate requests and handling responses appropriately.

------------------------------
Charles Reily
------------------------------

[smitbret]

Understand the API documentation thoroughly. Make sure it's comprehensive and up-to-date. This will help you understand the endpoints, request/response formats, authentication mechanisms, error codes, and any other relevant details. Determine how authentication and authorization are handled by the API. Are there API keys, OAuth tokens, or other methods used for authentication? Understand the roles and permissions associated with different users. Identify the data formats used for requests and responses. Common formats include JSON, XML, or form-urlencoded data. Ensure your automation framework supports parsing and generating these formats. Determine the required parameters for each API endpoint. Understand which parameters are optional and which are mandatory. Similarly, understand the structure of request payloads if any. Define how responses should be verified. Determine the expected status codes, response headers, and response bodies for each API endpoint. Consider edge cases and error scenarios.