Python中Sage CRM网页服务示例
我正在尝试为Sage CRM编写一个Python消费者，使用他们的Web服务接口。我选择了SOAPpy作为Python的SOAP库（并不是特别依赖它，只是因为在Ubuntu上安装很简单，所以就用了）。
我成功地通过代理获取了WSDL，并执行了Sage CRM提供的登录方法。
from SOAPpy import *
proxy = WSDL.Proxy('http://192.168.0.3/MATE/eware.dll/webservice/webservice.wsdl')
这个方法返回了一个会话对象，看起来大概是这样的：
SOAPpy.Types.structType result at 151924492: {'sessionid': '170911104429792'}
现在我想使用Sage CRM的queryrecord方法来查询数据，这个方法会返回：
Fault SOAP-ENV:Server: No active usersession detected
阅读文档后我发现，每次请求时都需要把登录时收到的会话ID发送回去。
根据Sage的文档，我需要这样发送它：
SID = binding.logon("admin", "");
binding.SessionHeaderValue = new SessionHeader();
binding.SessionHeaderValue.sessionId = SID.sessionid;
有没有人知道如何用SOAPpy把这个加到请求头里呢？
任何建议都非常感谢。
2 个回答
0
我也在慢慢搞明白这个事情。我已经完成了这个核心部分，所以这应该能帮助其他需要这个的人更快上手！我假设其他的Sage子系统也差不多是这个样子（不过我还不太确定），所以我尽量考虑到了这种可能性。
首先，你需要我写的一个模块，叫做pySage.py。这个模块定义了一个类，用来运行一个进程，你需要在这个基础上进行扩展，以便满足你的自定义需求。
#----------------------------
#
# pySage.py
#
# Author: BuvinJ
# Created: December, 2015
#
# This module defines the SageProcess class.
# This class handles connecting and disconnecting
# to Sage web services, and provides an object
# through which the web services can be accessed.
#
#----------------------------
# Download SOAPpy from: https://pypi.python.org/pypi/SOAPpy
from SOAPpy import WSDL, Types as soapTypes
from enum import Enum
SageSubsystem = Enum( 'SageSubsystem', 'CRM' )
# Define your sub system connection parameters here.
CRM_WSDL_FILE_URL = "http://CRMservername/CRMinstallname/eWare.dll/webservice/webservice.wsdl"
CRM_USER = "admin"
CRM_PASSWORD = ""
CRM_NAMESPACE = "http://tempuri.org/type"
#----------------------------
# SageProcess Class
# To use this class:
#
# 1) Create a SageProcess subclass and define the method
# body().
# 2) Instanitate an instance of the subclass, passing a
# SageSubsystem enumeration, e.g. SageSubsystem.CRM.
# 3) Invoke the run() method of the process instance.
# This will in turn invoke body() to execute your
# custom actions.
#
# To access the sage web services, use the "sage" member of
# a SageProcess instance. For help using Sage web service
# objects see:
# https://community.sagecrm.com/developerhelp/default.htm
#
# You may also invoke the sageHelp() method of a SageProcess
# instance to view the top level web service object members.
# Or, recordHelp( sageRecord ) to view the members of the
# various record objects returned by the web services.
#
#----------------------------
class SageProcess():
# Construction & service connection methods
#----------------------------
def __init__( self, subsystem, verbose=False ):
"""
@param subsystem: The Sage subsystem on which to run the process. Ex. SageSubsystem.CRM
@param verbose: If True, details of the SOAP exchange are displayed.
"""
self.subsystem = subsystem
self.verbose = verbose
if self.subsystem == SageSubsystem.CRM :
self.wsdl = CRM_WSDL_FILE_URL
self.namespace = CRM_NAMESPACE
self.username = CRM_USER
self.password = CRM_PASSWORD
else :
self.abort( "Unknown subsystem specified!" )
self.sessionId = None
self.connect()
def connect( self ) :
try :
self.sage = WSDL.Proxy( self.wsdl, namespace=self.namespace )
except :
self.abort( "WSDL failure. This is may be caused by access settings. File url: " + CRM_WSDL_FILE_URL )
if self.verbose : "Connected to web service."
self.soapProxy = self.sage.soapproxy
if self.verbose : self.sageDebug()
# Core process methods
#----------------------------
def run( self ) :
if not self.logOn( self.username, self.password ) :
self.abort( "Log On failed!" )
else :
if self.verbose :
print "Logged On. Session Id: " + str( self.sessionId )
self.appendSessionHeader()
self.body()
if self.logOff() :
if self.verbose : print "Logged Off."
def logOn( self, username, password ) :
try : self.sessionId = self.sage.logon( username, password ).sessionid
except Exception as e:
self.abortOnException( "Log On failure.\n(You may need to enable forced logins.)", e )
return (self.sessionId is not None)
def appendSessionHeader( self ) :
self.soapProxy = self.soapProxy._sa( "urn:sessionid" )
soapHeader = soapTypes.headerType()
soapHeader.SessionHeader = soapTypes.structType( None, "SessionHeader" )
soapHeader.SessionHeader.sessionId = soapTypes.stringType( self.sessionId )
self.soapProxy = self.soapProxy._hd( soapHeader )
self.sage.soapproxy = self.soapProxy
def body( self ) :
"""
You should override this method when you subclass SageProcess.
It will be called after logging on, and will be followed by logging off.
Use self.sage to access the system from within this method.
"""
def logOff( self ) :
success = False
try : success = self.sage.logoff( self.sessionId )
except Exception as e: self.abortOnException( "Log off failure.", e )
return success
# Helper methods
#----------------------------
# Immediately exit the program with an indication of success
def quit( self, msg=None ) :
if msg is not None: print msg
import os
os._exit( 0 )
# Immediately exit the program with an error
def abort( self, msg=None, errorCode=1 ) :
if msg is not None: print msg
print "Process terminated..."
import os
os._exit( errorCode )
# Immediately exit the program with an Exception error
def abortOnException( self, e, msg=None, errorCode=1 ) :
if msg is not None: print msg
print ""
print e
print ""
self.abort( None, errorCode )
def sageDebug( self, enable=True ) :
if enable : self.soapProxy.config.debug = 1
else : self.soapProxy.config.debug = 0
def sageHelp( self ) :
print "\nSage web service methods:\n"
self.sage.show_methods()
def recordHelp( self, record, typeDescr=None ) :
if record is None : return
print ""
description = "record object members:\n"
if typeDescr is not None :
description = typeDescr + " " + description
print description
print dir( record )
print ""
接下来，为这个类添加一个客户端。这里有一个我创建的示例，叫做fetch_company_data_example.py：
#----------------------------
#
# fetch_company_data_example.py
#
#----------------------------
from pySage import SageProcess, SageSubsystem
def main() :
# Get process parameters from the command line
import sys
try :
companyId = sys.argv[1]
except :
abort( "Usage: " + sys.argv[0] + " companyId [-v] [--verbose]" )
verbose = False
try :
if ( sys.argv[2] == "-v" or
sys.argv[2] == "--verbose" ) :
verbose = True
except : pass
# Create & run the custom Sage process
process = FetchCompanyDataProcess( companyId, verbose )
process.run()
class FetchCompanyDataProcess( SageProcess ):
def __init__( self, companyId, verbose ):
SageProcess.__init__( self, SageSubsystem.CRM, verbose )
self.companyId = companyId
def body( self ):
# Fetch the company record (exiting if no data is returned)
companyRecord = self.getCompanyRecord()
if companyRecord is None: self.quit( "\nNo records found.\n" )
# Uncomment for development help...
#if self.verbose : self.recordHelp( companyRecord, "Company" )
#if self.verbose : self.recordHelp( companyRecord.address.records, "Address" )
# Print some of the company info
print ""
print "Company Id: " + self.companyId
print "Name: " + companyRecord.name
print "Location: " + self.getCompanyLocation( companyRecord )
print ""
def getCompanyRecord( self ) :
try :
queryentity = self.sage.queryentity( self.companyId, "company" )
except Exception as e:
self.abortOnException( "Get Company Record failure.", e )
try : return queryentity.records
except : return None
def getCompanyLocation( self, companyRecord ) :
try :
return (companyRecord.address.records.city + ", " +
companyRecord.address.records.state)
except : return ""
# Entry point
if __name__ == '__main__' : main()
0
首先，关于SOAPpy和其他SOAP库的比较... SOAPpy通常是一个易于使用的库，但它不支持复杂的数据结构。所以如果它能满足你的需求，那你就可以继续使用它。如果你需要处理WSDL中的复杂数据结构，就得考虑使用ZSI了。
不过，SourceForge上这个项目的文档链接似乎坏掉了，所以我就把头部文档复制粘贴过来，稍微调整了一下格式：
使用头部
SOAPpy有一个Header类，用来存放SOAP消息的头部数据。每个Header实例都有方法来设置和获取MustUnderstand属性，还有方法来设置和获取Actor属性。
SOAPpy还提供了一个SOAPContext类，这样每个服务器方法都可以实现得让它获取连接客户端的上下文信息。这包括一些常见的SOAP信息和连接信息（下面有个例子）。
客户端示例
import SOAPpy
test = 42
server = SOAPpy.SOAPProxy("http://localhost:8888")
server = server._sa ("urn:soapinterop")
hd = SOAPpy.Header()
hd.InteropTestHeader ='This should fault, as you don\'t understand the header.'
hd._setMustUnderstand ('InteropTestHeader', 0)
hd._setActor ('InteropTestHeader','http://schemas.xmlsoap.org/soap/actor/next')
server = server._hd (hd)
print server.echoInteger (test)
这个应该能成功（前提是服务器定义了echoInteger），因为它在这个客户端中构建了一个有效的头部，MustUnderstand设置为0，然后发送带有这个头部的SOAP消息。
import SOAPpy
test = 42
server = SOAPpy.SOAPProxy("http://localhost:8888")
server = server._sa ("urn:soapinterop")
#Header
hd = SOAPpy.Header()
hd.InteropTestHeader = 'This should fault,as you don\'t understand the header.'
hd._setMustUnderstand ('InteropTestHeader', 1)
hd._setActor ('InteropTestHeader','http://schemas.xmlsoap.org/soap/actor/next')
server = server._hd (hd)
print server.echoInteger (test)
这个应该会失败（即使服务器定义了'echoInteger'），因为它在这个客户端中构建了一个有效的头部，但将MustUnderstand设置为1，发送的消息服务器可能根本无法理解。