API documentation

Chave API

Para poder utilizar a API Fotolia, deverá ter uma chave API. Essa chave API é indispensável para poder efectuar pedidos a través da API. Pode obter uma chave na secção « Ferramentas » do seu espaço pessoal e preenchendo o formulário API. Estão disponíveis 3 tipos de chaves: a chave API Parceiros, a chave API Negócios e a chave API Criativos. Algumas modalidades podem não estar disponíveis, dependendo da chave que dispõe. Dê uma vista de olhos ao quadro seguinte para verificar quais as modalidades que lhe estão acessíveis. É possível ter várias chaves API. Cada aplicação criada deve ser associada a uma chave API diferente.

Condições Gerais de Utilização da API.

As Condições Gerais de Utilização da API determinam os direitos e as condições de utilização de cada API. Agradecíamos que tomasse conhecimento das Condições Gerais de Utilização da API da API apropriada antes de a utilizar.

Code

A API Fotolia necessita que todos os dados estejam codificados em UTF-8. Mais informações sobre l'UTF-8

Autenticação

Alguns métodos necessitam de uma autenticação (ver o quadro mais abaixo). A autenticação s’o está disponível para a API Criativos e a API Negócios. O processo de identificação é semelhante ao processo de identificação no site Fotolia (Login). Os Logins e Palavras-passe devem ser enviados de modo seguro graças à API e, depois de serem identificados, será atribuído uma ID de sessão. Essa ID de sessão será depois necessária para utilizar os métodos com autenticação. Para mais informações sobre a autenticação, queira consultar o métodoLoginUser.

Métodos

Os métodos permitem executar diferentes funcionalidades a través da API. O quadro seguinte indica os métodos disponíveis para cada tipo de API. Os outros métodos serão acrescentados brevemente.

Métodos API Parceiros API Negócios API Criativos API Reseller Autenticação Descrição
Pesquisa
getSearchResults Authorized Authorized Authorized Authorized não Total capacidade de pesquisa
getCategories1 Authorized Authorized Authorized Authorized não Reenvia as categorias representativas
getCategories2 Authorized Authorized Authorized Authorized não Reenvia as categorias conceptuais
getTags Authorized Authorized Authorized Authorized não Reenvia a núvem de tags
getGalleries Authorized Authorized Authorized Authorized não Reenvia as galerias públicas
getColors Authorized Authorized Authorized Authorized não Reenvia o quadro das cores
getCountries Authorized Authorized Authorized Authorized não Reenvia a lista dos países
Ficheiro
getMediaData Authorized Authorized Authorized Authorized não Reenvia todas as informações sobre um ficheiro
getMediaGalleries Authorized Authorized Authorized Authorized não Reenvia as galerias relativas ao ficheiro
getMedia Prohibited Authorized Prohibited Authorized sim Reenvia o link de download (ficheiro comprado)
getMediaComp Authorized Authorized Authorized Authorized não Reenvia o URL da imagem em miniatura
Utilizador
loginUser Prohibited Authorized Authorized Authorized não Identificar um utilizador (necessário para a autentificação)
logoutUser Prohibited Authorized Authorized Authorized sim Desconectar um utilizador (terminar a sessão)
getUserData Prohibited Authorized Authorized Authorized sim Reenvia as informações sobre o utilizador identificado
getUserStats Prohibited Authorized Authorized Authorized sim Reenvia as estatísticas da conta de um utilizador identificado
getUserGalleries Prohibited Authorized Authorized Authorized sim Reenvia as galerias de um utilizador identificado
getUserGalleryMedias Prohibited Authorized Authorized Authorized sim Reenvia as imagens da lightbox/galeria de um utilizador identificado
deleteUserGallery Prohibited Authorized Authorized Authorized sim eliminar a galeria de um utilizador identificado
createUserGallery Prohibited Authorized Authorized Authorized sim criar uma nova galeria para um utilizador identificado
addToUserGallery Prohibited Authorized Authorized Authorized sim adicionar um ficheiro na galeria de um utilizador identificado
removeFromUserGallery Prohibited Authorized Authorized Authorized sim apagar um ficheiro da galeria de um utilizador identificado
getUserAdvancedStats Prohibited Authorized Authorized Authorized sim obter resultados da pesquisa avançada sobre as estatísticas da conta de um utilizador identificado
Geral
getData Authorized Authorized Authorized Authorized não Reenvia as informações gerais a propósito de Fotolia
test Authorized Authorized Authorized Authorized não Reenvia "success"
API Reseller
user.subaccount.getIds Prohibited Prohibited Prohibited Authorized não Lista de todos os ID das sub-contas
user.subaccount.create Prohibited Prohibited Prohibited Authorized não Criar uma sub-conta reseller
user.subaccount.delete Prohibited Prohibited Prohibited Authorized não Apagar uma sub-conta reseller
user.subaccount.edit Prohibited Prohibited Prohibited Authorized não Actualizar os dados de uma sub-conta reseller
user.subaccount.get Prohibited Prohibited Prohibited Authorized não Obter detalhes de uma sub-conta reseller
user.subaccount.getPurchasedContents Prohibited Prohibited Prohibited Authorized não Obter a lista das compras efectuadas por uma sub-conta
media.getLicense Prohibited Prohibited Prohibited Authorized não Obter a licença de uma determinada venda entre o revendedor e o seu cliente.

Formato dos pedidos

XML/RPC

O formato XML/RPC é válido para os pedidos e as respostas. O XML-RPC é um protocolo (Remote Procedure Calling) que fonciona na Internet. Uma messagem XML-RPC é um pedido HTTP-POST. O corpo do pedido (Body) está em XML. Um procedimento é executado no servidor e o valor que ele reenvia está igualmente formatado em XML. Mais informações sobre o XML/RPC

Cabeçalho


POST /Xmlrpc/rpc HTTP/1.0
Host: api.fotolia.com
Connection: close
Content-Type: text/xml
Content-Length: 569

Exemplo de pedido


<?xml version="1.0" encoding="utf-8"?>

<methodCall>
	<methodName>xmlrpc.test</methodName>
	<params>
		<param>
			<value>
				<string>YOUR_API_KEY</string>
			</value>
		</param>
	</params>
</methodCall>

Exemplo de resposta


<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>test</name>
            <value>
              <string>Success</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

Kits API

Pode utilizar um kit que o ajudará a simplificar a sua utilização da API. Veja aqui a lista dos kits disponíveis. Se desejar propor o seu kit, não hesite em contactar-nos, poderemos acrescentar um link para o seu site.

PHP

Ruby

Métodos

Pedido

Ficheiro

Utilizador

Geral