Getting Starting with API Programming

From ARSWiki

Jump to: navigation, search

Contents

Prerequisites

Before diving in...

Which API is Right for the Task at Hand?

AR System API interfaces are available for various platforms and various languages, each with varying degrees of support and capabilities. The decision points for your choice of API should include:

  • Is official support from Remedy a requirement for your organization
  • Your comfort level with the available languages
  • The capabilities of the API

Available API Interfaces

C

This is the base API interface into the ARSystem. All other API interfaces are wrappers of this API. The C API is shipped and supported by Remedy.

Java

There are two Java API's available for the arsystem.

Key differences:

  • Remedy's Java API is a commercially supported API interface into the ARSystem
  • Remedy's Java API is a fully featured set of all the C API capabilities, whereas JOARSE is a subset of the c api capabilities
  • Remedy's Java API exclusively uses arrays, whereas JOARSE uses Map or Vector when appropriate, making it more conventient and more efficient to use.
  • JOARSE gives you access to the complete source code (both Java and native, up to the C API itself).

RTL C++

This Sourceforge project is a templating library for C++ for the C API. more info

Perl

This is one of the oldest and most widely adopted of the non-Remedy sponsored API's. more info

COM Objects for the AR System

This Sourceforge project is an automation compatible COM wrapper to the C API. It is compatible with VB6, VBScript, JScript, VBA, and C++ COM clients. For example, it is compatible with VB macros in Excel or other Office applications. See http://www.sourceforge.net/projects/coarse.

.NET

There is a .NET API which is created for .NET 1.0. It is unsupported but available on the Remedy Supportweb under Community Downloads.

PHP

This one is brand new and so far it only supports reading and manipulating of data, not of server objects. more info

Remedy API Header and Library Files

Regardless of the api you choose (perl, c, java, rtl c++, php, etc.), Remedy's c api (header/library files) is required. This content is available for download on a separate page.

Retrieved from "http://arswiki.org/wiki/Getting_Starting_with_API_Programming"
Personal tools